Widget background. More...
#include <ubackground.hpp>
Inheritance diagram for ubit::UBackground:
Public Member Functions | |
| UBackground () | |
| creates an empty background attribute. | |
| UBackground (const UBackground &) | |
| creates a background from another one. | |
| UBackground (const UColor &) | |
| creates a background prop with a solid color (the UColor argument is copied). | |
| UBackground (UIma &) | |
| creates a background prop with an image (the UIma argument is copied). | |
| UBackground & | operator= (const UBackground &) |
| copies a background attribute from another one. | |
| bool | operator== (const UBackground &) |
| compares two background attributes. | |
| virtual UBackground & | setColor (const UColor &color) |
| changes the background color. More... | |
| virtual UBackground & | setRgba (const URgba &) |
| changes the background color. | |
| virtual UBackground & | setRbgaF (float r, float g, float b, float a=1.) |
| changes the background color, arguments are floats in range [0,1]. | |
| virtual UBackground & | setRbgaI (unsigned int r, unsigned int g, unsigned int b, unsigned int a=255) |
| changes the background color, arguments are integers in range [0,255]. | |
| virtual UBackground & | setNamedColor (const UStr &color_name, float a=1.) |
| changes the background color, arguments are a color name and an alpha value in range [0,1]. | |
| virtual UBackground & | setIma (UIma &image, bool tiling=true) |
| changes the background image (WARNING: see details). More... | |
| UBackground & | setTiling (bool) |
| sets tiling on or off. | |
| const UColor * | getColor () const |
| returns the current color if any; null otherwise. | |
| const UIma * | getIma () const |
| returns the current image if any; null otherwise. | |
| bool | isTiled () const |
| returns true if the image is tiled. | |
| virtual void | update () |
| updates parents graphics. | |
| virtual void | putProp (UUpdateContext *, UElem &) |
| [impl] changes corresponding value in the UUpdateContext | |
| UBackground (UColor &, UConst) | |
| UBackground (UIma &, UConst) | |
 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 () |
| virtual void | changed (bool update=true) |
| [impl] called when object's content is changed. More... | |
| 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. | |
Static Public Attributes | |
| static UBackground | none |
| static UBackground | inherit |
| static UBackground | metal |
| static UBackground | velin |
| static UBackground | white |
| static UBackground | black |
| static UBackground | grey |
| static UBackground | lightgrey |
| static UBackground | darkgrey |
| static UBackground | navy |
| static UBackground | lightblue |
| static UBackground | blue |
| static UBackground | red |
| static UBackground | green |
| static UBackground | yellow |
| static UBackground | orange |
| static UBackground | wheat |
| static UBackground | teal |
| predefined background constants. | |
| 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... | |
Protected Attributes | |
| uptr< UColor > | pcolor |
| uptr< UIma > | pima |
| float | alpha |
| bool | tiling |
| 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 () |
| 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 | 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... | |
| virtual void | destructs () |
| unlinks the object from its parents and destroys its children. | |
Detailed Description
Widget background.
This attributes controls the background of widgets (objects deriving from UBox). If not added to the widget's attribute list, the default background specified in the widget's UStyle is used. This default background if transparent for most widgets, so that the background of the first non transparent parent widget will appear.
Member Function Documentation
§ setColor()
|
virtual |
changes the background color.
the UColor argument is copied internally so that this background will remain valid if this argument is destroyed.
§ setIma()
|
virtual |
changes the background image (WARNING: see details).
WARNING: the UIma argument is NOT copied internally: this background will NOT be valid if this argument is destroyed.
The documentation for this class was generated from the following files:
- src/ubit/ubackground.hpp
- src/ubit/ubackground.cpp
