Makes the children of a widget (exclusively) selectable. More...
#include <uchoice.hpp>
Inheritance diagram for ubit::UChoice:
Classes | |
| struct | IsSelectable |
Public Member Functions | |
| UChoice () | |
| create a new UChoice object; More... | |
| virtual void | clearSelection () |
| deselects the selected object. | |
| virtual UBox * | getSelectedItem () const |
| returns the current selection; returns null if there is no selection. | |
| virtual UBox * | setSelectedItem (UBox &) |
| selects and returns this item if it is in the list, returns null otherwise. | |
| virtual UBox * | setSelectedItem (UBox *) |
| selects this item or clear the selection if this item is null. | |
| virtual int | getSelectedIndex () const |
| returns the index of the selection; returns -1 if there is no selection. More... | |
| virtual UBox * | setSelectedIndex (int N) |
| selects the Nth selectable object in the list. More... | |
| virtual UBox * | getSelectableItem (int N) const |
| returns the Nth selectable object. More... | |
| virtual UBox * | getSelectableItem (const UStr &s, bool ignore_case=true) const |
| returns the 1st selectable object which contains a string equal to 's'. More... | |
| virtual void | setSelectionRule (IsSelectable &) |
| define which objects can be selected in the list. More... | |
| virtual void | update () |
| updates parents graphics. | |
| virtual void | putProp (UUpdateContext *, UElem &) |
| [impl] changes corresponding value in the UUpdateContext | |
| virtual void | addingTo (UChild &, UElem &parent) |
| called when this object is added to a parent. | |
| virtual void | removingFrom (UChild &, UElem &parent) |
| called when this object is removed from a parent (SEE DETAILS IF YOU REDEFINE THIS METHOD). More... | |
 Public Member Functions inherited from ubit::UAttr | |
| UAttr (UConst) | |
| virtual UAttr * | toAttr () |
| dynamic cast: returns this object if it derives from UAttr and null otherwise. | |
| virtual const UAttr * | toAttr () const |
| dynamic cast: returns this object if it derives from UAttr and null otherwise. | |
| virtual int | getDisplayType () const |
| virtual int | getNodeType () const |
| returns the XML node type. | |
| virtual const UStr & | getNodeName () const |
| returns the name of this attribute (calls getName()). | |
| virtual UStr | getNodeValue () const |
| returns the value of this attribute (calls getValue()). | |
| virtual const UStr & | getName () const |
| returns the name of this attribute. | |
| virtual bool | getValue (UStr &value) const |
| gets the value of this attribute. More... | |
| virtual void | setValue (const UStr &value) |
| changes the value of this attribute does nothing if not applicable for a given subclass. | |
| virtual void | initNode (UDoc *, UElem *parent) |
| called when the document is created. | |
| virtual UAttr & | onChange (UCall &) |
| adds a callback that is fired when the value of the property is modified. More... | |
| UAttr & | setConst () |
| Public Member Functions inherited from ubit::UNode | |
| virtual int | isDisplayable () const |
| virtual UNode * | toNode () |
| dynamic cast: returns this object if it derives from UNode and null otherwise. | |
| virtual const UNode * | toNode () const |
| dynamic cast: returns this object if it derives from UNode and null otherwise. | |
| virtual bool | isChildOf (const UElem &parent, bool indirect=true) const |
| returns true if this object a child of 'parent'. More... | |
| UParentIter | pbegin () const |
| returns an iterator to the beginning of the list of direct parents. More... | |
| UParentIter | pend () const |
| returns an iterator to the end of the parent list ( More... | |
| virtual UParents & | parents () const |
| returns the list of direct parents ( More... | |
| virtual UElem * | getParent (int pos=0) const |
| returns the Nth direct parent. More... | |
| virtual bool | hasSceneGraphParent () const |
| template<class CC > | |
| CC * | findParent () const |
| < this object has at least one parent in the scene graph. More... | |
| virtual int | getBoxParents (std::vector< UBox *> &parvect) const |
| retrieves direct and indirect parents that are boxes. | |
| virtual UBox * | getParent (const UView *) const |
| returns the direct or indirect parent that contains this view. More... | |
| virtual UView * | getParentView (const UView *) const |
| returns the direct or indirect parent's view that contains this view. More... | |
| virtual UBox * | getParent (const UInputEvent &) const |
| virtual UView * | getParentView (const UInputEvent &) const |
| virtual void | removeFromParents (bool update_parents=true) |
| [impl] removes this object from all direct parents. More... | |
| virtual bool | fire (UEvent &) const |
| fires callback functions that match this event. | |
| virtual UNode & | removeAllAttrs (bool autodel=true) |
| removes all attributes (if any, redefined by subclasses). | |
| bool | isAutoUpdate () const |
| return current update policy: see setAutoUpdate(). | |
| UNode & | setAutoUpdate (bool state=true) |
| changes the update policy of this object when its is modified. More... | |
| void | fireParents (const UCond &c, UNode *n) const |
| void | updateAutoParents (const UUpdate &m) |
| virtual void | addChangeCall (UCall &) |
| virtual UElem * | getSubGroup () const |
| void | _addAttr (const UChild &attribute) |
| [impl] to be removed @. | |
| UChildIter | _abegin () const |
| [impl] to be removed @. | |
| UChildIter | _aend () const |
| [impl] to be removed @. | |
| Public Member Functions inherited from ubit::UObject | |
| UObject (const UObject &) | |
| UObject & | operator= (const UObject &) |
| virtual const UClass & | getClass () const |
| instance method that returns the metaclass of this object. More... | |
| const UStr & | getClassName () const |
| returns getClass().getName(). | |
| virtual void | error (const char *function_name, const char *format,...) const |
| prints out an error message. More... | |
| virtual void | warning (const char *function_name, const char *format,...) const |
| prints out a warning message: More... | |
| bool | isDeletable () const |
| checks if this object can be destroyed by 'delete'. More... | |
| bool | isConst () const |
| checks whether the content of this object can be modified ( More... | |
| UObject & | setConst () |
| specifies that the content of this object cannot be modified. More... | |
| bool | isAutoUpdate () const |
| return current update policy: More... | |
| UObject & | setAutoUpdate (bool state=true) |
| changes the update policy of this object when its is modified. More... | |
| bool | isIgnoringChangeCallbacks () const |
| return true if change callbacks are fired. | |
| UObject & | ignoreChangeCallbacks (bool state) |
| change callbacks are not fired if argument is true. | |
| virtual UElem * | toElem () |
| dynamic cast: returns this object if it derives from UElem and null otherwise. | |
| virtual const UElem * | toElem () const |
| dynamic cast: returns this object if it derives from UElem and null otherwise. | |
| virtual UData * | toData () |
| dynamic cast: returns this object if it derives from UData and null otherwise. | |
| virtual const UData * | toData () const |
| dynamic cast: returns this object if it derives from UData and null otherwise. | |
| virtual UStr * | toStr () |
| dynamic cast: returns this object if it derives from UStr and null otherwise. | |
| virtual const UStr * | toStr () const |
| dynamic cast: returns this object if it derives from UStr and null otherwise. | |
| virtual UCall * | toCall () |
| dynamic cast: returns this object if it derives from UCall and null otherwise. | |
| virtual const UCall * | toCall () const |
| dynamic cast: returns this object if it derives from UCall and null otherwise. | |
| virtual UBox * | toBox () |
| dynamic cast: returns this object if it derives from UBox and null otherwise. | |
| virtual const UBox * | toBox () const |
| dynamic cast: returns this object if it derives from UBox and null otherwise. | |
| virtual UWin * | toWin () |
| dynamic cast: returns this object if it derives from UWin and null otherwise. | |
| virtual const UWin * | toWin () const |
| dynamic cast: returns this object if it derives from UWin and null otherwise. | |
| virtual UMenu * | toMenu () |
| dynamic cast: returns this object if it derives from UMenu and null otherwise. | |
| virtual const UMenu * | toMenu () const |
| dynamic cast: returns this object if it derives from UMenu and null otherwise. | |
| State | getState () const |
| returns the current object state. | |
| void | setState (State s) |
| changes the object state. | |
| PtrCount | getPtrCount () const |
| [impl] returns the number of uptr<> smart pointers that are pointing to this object. | |
| bool | checkConst () const |
| [impl] produces an error if this object is logically constant ( More... | |
| bool | isDestructed () const |
| [impl] this object has been destructed (but memory has not been freed yet). | |
| bool | isDestructing () const |
| [impl] this object is being destructed (one of its destructors has been called). | |
| void * | operator new (size_t) |
| < [impl] returns true if there is at least one scene graph parent (redefined by UNode). More... | |
| void | operator delete (void *) |
| delete operator is forbidden on instances that derive from UObject. | |
| void | addPtr () const |
| [Impl] a uptr is added to this object. | |
| void | removePtr () const |
| [Impl] a uptr is removed from this object. | |
Protected Member Functions | |
| virtual void | mouseCB (UInputEvent &) |
| virtual void | actionCB (UInputEvent *) |
| virtual void | changeCB (UInputEvent *) |
| virtual void | changed (bool update=true) |
| [impl] called when object's content is changed. More... | |
| virtual UBox * | setSelectedItemImpl (UBox *item, UInputEvent *) |
| virtual UBox * | getSelectedItemImpl () const |
| Protected Member Functions inherited from ubit::UNode | |
| UNode () | |
| constructor, can anly be called by subclasses because UNode is abstract. | |
| virtual | ~UNode () |
| destructor, note that children are recursively destroyed except if pointed elsewhere ( More... | |
| virtual void | destructs () |
| unlinks the object from its parents and destroys its children. | |
Protected Attributes | |
| uptr< UCall > | callbacks |
| uptr< UBox > | container |
| uptr< UElem > | last_browsing_group |
| uptr< UElem > | sel_items |
| IsSelectable * | is_selectable |
| Protected Attributes inherited from ubit::UNode | |
| UParents | _parents |
| UChildren | _attributes |
| Protected Attributes inherited from ubit::UObject | |
| PtrCount | ptr_count |
| Modes | omodes |
| State | ostate |
Additional Inherited Members | |
| Public Types inherited from ubit::UNode | |
| enum | NodeType { ELEMENT_NODE = 1, ATTRIBUTE_NODE = 2, TEXT_NODE = 3, CDATA_SECTION_NODE = 4, ENTITY_REFERENCE_NODE = 5, ENTITY_NODE = 6, PROCESSING_INSTRUCTION_NODE = 7, COMMENT_NODE = 8, DOCUMENT_NODE = 9, DOCUMENT_TYPE_NODE = 10, DOCUMENT_FRAGMENT_NODE = 11, NOTATION_NODE = 12 } |
| redefines Class() and getClass() methods ( More... | |
| enum | DisplayType { WINLIST =-1, UNDISPLAYBLE =0, ATTRIBUTE, DATA, INLINE, BLOCK, BORDER, HARDWIN, SOFTWIN } |
| Ubit display types. | |
| Public Types inherited from ubit::UObject | |
| typedef unsigned char | State |
| typedef short | PtrCount |
| Static Public Member Functions inherited from ubit::UObject | |
| static const char * | getVersion () |
| returns the version of the Ubit package. | |
| static const UClass & | Class () |
| class method that returns the metaclass of this class. More... | |
| static UStyle * | createStyle () |
| Static Public Attributes inherited from ubit::UObject | |
| static UConst | UCONST |
| UCONST can be given as an argument to some constructors to make the object constant. More... | |
Detailed Description
Makes the children of a widget (exclusively) selectable.
This object makes the CHILDREN of a widget selectable. It must be added to the chilsd or attribute list of this widget. Selection is exclusive. No child is initially selected. UListbox, UTreebox, UCombobox use an internal UChoice
- See also
- also: URadioSelect.
Constructor & Destructor Documentation
§ UChoice()
| UChoice::UChoice | ( | ) |
create a new UChoice object;
- See also
- also shortcut uchoice().
Member Function Documentation
§ changed()
|
protectedvirtual |
[impl] called when object's content is changed.
This function updates graphics (if 'update' is true) then fires parents' UOn::propChange callbacks
Reimplemented from ubit::UAttr.
§ getSelectableItem() [1/2]
|
virtual |
returns the Nth selectable object.
the last selectable object is returned if N = -1. NOTE: A list can contain non-selectable objects, which are ignored when counting indexes. Use getChild() to have access to all objects.
§ getSelectableItem() [2/2]
|
virtual |
returns the 1st selectable object which contains a string equal to 's'.
this function compares the content of the strings (not their addresses). NOTE: A list can contain non-selectable objects, which are ignored by this function. Use getChild() to have access to all objects.
§ getSelectedIndex()
|
virtual |
returns the index of the selection; returns -1 if there is no selection.
NOTE: the returned value is the index among the selectable objects of the list. A list can contain non-selectable objects, which are ignored when counting indexes.
§ removingFrom()
called when this object is removed from a parent (SEE DETAILS IF YOU REDEFINE THIS METHOD).
!BEWARE: subclasses that redefine removingFrom() MUST HAVE A DESTRUCTOR that calls destructs().
DETAILS: this is because of a C++ subtletly: as polymorphism is deactivated in destructors, a redefined removingFrom() method won't be called except if destructs() - that calls removingFrom() - is called in the destructor of the class that redefines removingFrom()).
Reimplemented from ubit::UNode.
§ setSelectedIndex()
|
virtual |
selects the Nth selectable object in the list.
the last selectable object is selected if N = -1. The selected object is returned (if any, null is returned otherwise). NOTE: N is the index of the Nth selectable object. A list can contain non-selectable objects, which are ignored when counting indexes.
§ setSelectionRule()
|
virtual |
The documentation for this class was generated from the following files:
- src/ubit/uchoice.hpp
- src/ubit/uchoice.cpp
