X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=pyatspi%2Fselection.py;h=6a201a89191a486e55b2caec2bef9294145a3626;hb=f8c5afeef077e71b231674985107bc380528e0c7;hp=3811061d35be83847a8e8c0e94589d51534aab55;hpb=b93edf847d229f40394cb0b4f721c4c2a5897d84;p=platform%2Fcore%2Fuifw%2Fat-spi2-atk.git diff --git a/pyatspi/selection.py b/pyatspi/selection.py index 3811061..6a201a8 100644 --- a/pyatspi/selection.py +++ b/pyatspi/selection.py @@ -14,122 +14,122 @@ import interfaces from base import BaseProxy -from factory import add_accessible_class +from factory import accessible_factory __all__ = [ - "Selection", - ] + "Selection", + ] #------------------------------------------------------------------------------ class Selection(BaseProxy): - """ - An interface which indicates that an object exposes a 'selection' - model, allowing the selection of one or more of its children. - Read-only Selection instances are possible, in which case the - interface is used to programmatically determine the selected-ness - of its children. A selected child has State::STATE_SELECTED, - and a child which may hypothetically be selected (though possibly - not programmatically selectable) has State::STATE_SELECTABLE. - """ - - def clearSelection(self, *args, **kwargs): """ - Attempt to clear all selections (i.e. deselect all children) - of a Selection. Not all Selection implementations allow the removal - of all selections. - @return True if the selections were successfully cleared, False - otherwise. + An interface which indicates that an object exposes a 'selection' + model, allowing the selection of one or more of its children. + Read-only Selection instances are possible, in which case the + interface is used to programmatically determine the selected-ness + of its children. A selected child has State::STATE_SELECTED, + and a child which may hypothetically be selected (though possibly + not programmatically selectable) has State::STATE_SELECTABLE. """ - func = self.get_dbus_method("clearSelection") - return func(*args, **kwargs) - - def deselectChild(self, *args, **kwargs): - """ - Remove a child from the selected children list of a Selection, - if the child is currently selected. - @param : childIndex - a long integer (the zero offset index into the Accessible object's - list of children) indicating which child of the Selection is - to be selected. - @return True if the child was successfully selected, False otherwise. - """ - func = self.get_dbus_method("deselectChild") - return func(*args, **kwargs) - - def deselectSelectedChild(self, *args, **kwargs): - """ - Remove a child to the selected children list of a Selection. - @param : selectedChildIndex - a long integer indicating which of the selected children of the - Selection is to be deselected. The index is a zero-offset index - into the 'selected child list', not a zero-offset index into - the list of all children of the Selection. - @return True if the child was successfully deselected, False - otherwise. - """ - func = self.get_dbus_method("deselectSelectedChild") - return func(*args, **kwargs) - - def getSelectedChild(self, *args, **kwargs): - """ - Get the i-th selected Accessible child of a Selection. - @param : selectedChildIndex - a long integer indicating which of the selected children of an - object is being requested. - @return a pointer to a selected Accessible child object, specified - by selectedChildIndex. - """ - func = self.get_dbus_method("getSelectedChild") - return func(*args, **kwargs) - - def isChildSelected(self, *args, **kwargs): - """ - Determine whether a particular child of an Selection implementor - is currently selected. Note that childIndex is the zero-offset - index into the standard Accessible container's list of children. - @param : childIndex - an index into the Selection's list of children. - @return True if the specified child is currently selected, False - otherwise. - """ - func = self.get_dbus_method("isChildSelected") - return func(*args, **kwargs) - - def selectAll(self, *args, **kwargs): - """ - Attempt to select all of the children of a Selection implementor. - Not all Selection implementors support this operation (for instance, - implementations which support only "single selection" do not - support this operation). - @return True if successful, False otherwise. - """ - func = self.get_dbus_method("selectAll") - return func(*args, **kwargs) - - def selectChild(self, *args, **kwargs): - """ - Add a child to the selected children list of a Selection. - @param : childIndex - a long integer indicating which child of the Selection is to - be selected. - @return True if the child was successfully selected, False otherwise. - """ - func = self.get_dbus_method("selectChild") - return func(*args, **kwargs) - - def get_nSelectedChildren(self): - return self._pgetter(self._dbus_interface, "nSelectedChildren") - def set_nSelectedChildren(self, value): - self._psetter(self._dbus_interface, "nSelectedChildren", value) - _nSelectedChildrenDoc = \ - """ - The number of children of a Selection implementor which are currently - selected. - """ - nSelectedChildren = property(fget=get_nSelectedChildren, fset=set_nSelectedChildren, doc=_nSelectedChildrenDoc) -# ATTENTION - Register the Application class with the accessible factory. -add_accessible_class(interfaces.ATSPI_SELECTION, Selection) + def clearSelection(self, *args, **kwargs): + """ + Attempt to clear all selections (i.e. deselect all children) + of a Selection. Not all Selection implementations allow the removal + of all selections. + @return True if the selections were successfully cleared, False + otherwise. + """ + func = self.get_dbus_method("clearSelection") + return func(*args, **kwargs) + + def deselectChild(self, *args, **kwargs): + """ + Remove a child from the selected children list of a Selection, + if the child is currently selected. + @param : childIndex + a long integer (the zero offset index into the Accessible object's + list of children) indicating which child of the Selection is + to be selected. + @return True if the child was successfully selected, False otherwise. + """ + func = self.get_dbus_method("deselectChild") + return func(*args, **kwargs) + + def deselectSelectedChild(self, *args, **kwargs): + """ + Remove a child to the selected children list of a Selection. + @param : selectedChildIndex + a long integer indicating which of the selected children of the + Selection is to be deselected. The index is a zero-offset index + into the 'selected child list', not a zero-offset index into + the list of all children of the Selection. + @return True if the child was successfully deselected, False + otherwise. + """ + func = self.get_dbus_method("deselectSelectedChild") + return func(*args, **kwargs) + + def getSelectedChild(self, *args, **kwargs): + """ + Get the i-th selected Accessible child of a Selection. + @param : selectedChildIndex + a long integer indicating which of the selected children of an + object is being requested. + @return a pointer to a selected Accessible child object, specified + by selectedChildIndex. + """ + func = self.get_dbus_method("getSelectedChild") + return func(*args, **kwargs) + + def isChildSelected(self, *args, **kwargs): + """ + Determine whether a particular child of an Selection implementor + is currently selected. Note that childIndex is the zero-offset + index into the standard Accessible container's list of children. + @param : childIndex + an index into the Selection's list of children. + @return True if the specified child is currently selected, False + otherwise. + """ + func = self.get_dbus_method("isChildSelected") + return func(*args, **kwargs) + + def selectAll(self, *args, **kwargs): + """ + Attempt to select all of the children of a Selection implementor. + Not all Selection implementors support this operation (for instance, + implementations which support only "single selection" do not + support this operation). + @return True if successful, False otherwise. + """ + func = self.get_dbus_method("selectAll") + return func(*args, **kwargs) + + def selectChild(self, *args, **kwargs): + """ + Add a child to the selected children list of a Selection. + @param : childIndex + a long integer indicating which child of the Selection is to + be selected. + @return True if the child was successfully selected, False otherwise. + """ + func = self.get_dbus_method("selectChild") + return func(*args, **kwargs) + + def get_nSelectedChildren(self): + return self._pgetter(self._dbus_interface, "nSelectedChildren") + def set_nSelectedChildren(self, value): + self._psetter(self._dbus_interface, "nSelectedChildren", value) + _nSelectedChildrenDoc = \ + """ + The number of children of a Selection implementor which are currently + selected. + """ + nSelectedChildren = property(fget=get_nSelectedChildren, fset=set_nSelectedChildren, doc=_nSelectedChildrenDoc) + +# Register the accessible class with the factory. +accessible_factory.register_accessible_class(interfaces.ATSPI_SELECTION, Selection) #END----------------------------------------------------------------------------