ubit
Public Member Functions | List of all members
ubit::UHtmlBgcolor Struct Reference
Inheritance diagram for ubit::UHtmlBgcolor:
ubit::UBackground ubit::UAttr ubit::UNode ubit::UObject

Public Member Functions

void setValue (const UStr &)
 changes the value of this attribute does nothing if not applicable for a given subclass.
 
bool getValue (UStr &val) const
 gets the value of this attribute. More...
 
- Public Member Functions inherited from ubit::UBackground
 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).
 
UBackgroundoperator= (const UBackground &)
 copies a background attribute from another one.
 
bool operator== (const UBackground &)
 compares two background attributes.
 
virtual UBackgroundsetColor (const UColor &color)
 changes the background color. More...
 
virtual UBackgroundsetRgba (const URgba &)
 changes the background color.
 
virtual UBackgroundsetRbgaF (float r, float g, float b, float a=1.)
 changes the background color, arguments are floats in range [0,1].
 
virtual UBackgroundsetRbgaI (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 UBackgroundsetNamedColor (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 UBackgroundsetIma (UIma &image, bool tiling=true)
 changes the background image (WARNING: see details). More...
 
UBackgroundsetTiling (bool)
 sets tiling on or off.
 
const UColorgetColor () const
 returns the current color if any; null otherwise.
 
const UImagetIma () 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 UAttrtoAttr ()
 dynamic cast: returns this object if it derives from UAttr and null otherwise.
 
virtual const UAttrtoAttr () 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 UStrgetNodeName () const
 returns the name of this attribute (calls getName()).
 
virtual UStr getNodeValue () const
 returns the value of this attribute (calls getValue()).
 
virtual const UStrgetName () const
 returns the name of this attribute.
 
virtual void initNode (UDoc *, UElem *parent)
 called when the document is created.
 
virtual UAttronChange (UCall &)
 adds a callback that is fired when the value of the property is modified. More...
 
UAttrsetConst ()
 
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 UNodetoNode ()
 dynamic cast: returns this object if it derives from UNode and null otherwise.
 
virtual const UNodetoNode () 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 UParentsparents () const
 returns the list of direct parents ( More...
 
virtual UElemgetParent (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 UBoxgetParent (const UView *) const
 returns the direct or indirect parent that contains this view. More...
 
virtual UViewgetParentView (const UView *) const
 returns the direct or indirect parent's view that contains this view. More...
 
virtual UBoxgetParent (const UInputEvent &) const
 
virtual UViewgetParentView (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 UNoderemoveAllAttrs (bool autodel=true)
 removes all attributes (if any, redefined by subclasses).
 
bool isAutoUpdate () const
 return current update policy: see setAutoUpdate().
 
UNodesetAutoUpdate (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 UElemgetSubGroup () 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 &)
 
UObjectoperator= (const UObject &)
 
virtual const UClassgetClass () const
 instance method that returns the metaclass of this object. More...
 
const UStrgetClassName () 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...
 
UObjectsetConst ()
 specifies that the content of this object cannot be modified. More...
 
bool isAutoUpdate () const
 return current update policy: More...
 
UObjectsetAutoUpdate (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.
 
UObjectignoreChangeCallbacks (bool state)
 change callbacks are not fired if argument is true.
 
virtual UElemtoElem ()
 dynamic cast: returns this object if it derives from UElem and null otherwise.
 
virtual const UElemtoElem () const
 dynamic cast: returns this object if it derives from UElem and null otherwise.
 
virtual UDatatoData ()
 dynamic cast: returns this object if it derives from UData and null otherwise.
 
virtual const UDatatoData () const
 dynamic cast: returns this object if it derives from UData and null otherwise.
 
virtual UStrtoStr ()
 dynamic cast: returns this object if it derives from UStr and null otherwise.
 
virtual const UStrtoStr () const
 dynamic cast: returns this object if it derives from UStr and null otherwise.
 
virtual UCalltoCall ()
 dynamic cast: returns this object if it derives from UCall and null otherwise.
 
virtual const UCalltoCall () const
 dynamic cast: returns this object if it derives from UCall and null otherwise.
 
virtual UBoxtoBox ()
 dynamic cast: returns this object if it derives from UBox and null otherwise.
 
virtual const UBoxtoBox () const
 dynamic cast: returns this object if it derives from UBox and null otherwise.
 
virtual UWintoWin ()
 dynamic cast: returns this object if it derives from UWin and null otherwise.
 
virtual const UWintoWin () const
 dynamic cast: returns this object if it derives from UWin and null otherwise.
 
virtual UMenutoMenu ()
 dynamic cast: returns this object if it derives from UMenu and null otherwise.
 
virtual const UMenutoMenu () 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.
 

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 UClassClass ()
 class method that returns the metaclass of this class. More...
 
static UStylecreateStyle ()
 
- Static Public Attributes inherited from ubit::UBackground
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 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.
 
- Protected Attributes inherited from ubit::UBackground
uptr< UColorpcolor
 
uptr< UImapima
 
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
 

Member Function Documentation

§ getValue()

bool ubit::UHtmlBgcolor::getValue ( UStr value) const
inlinevirtual

gets the value of this attribute.

return false if this attribute has no value. Stores it in argument 'value' otherwise,

Reimplemented from ubit::UAttr.


The documentation for this struct was generated from the following files: