|
| NamedElement (const String &name="") |
| Constructor. More...
|
|
virtual | ~NamedElement () |
| Destructor.
|
|
virtual void | setName (const String &name) |
| Renames the element. More...
|
|
const String & | getName () const |
| Return a String object holding the name of this Element.
|
|
String | getNamePath () const |
| Return a String object that describes the name path for this Element.
|
|
bool | isChild (const String &name_path) const |
| Checks whether given name path references a NamedElement that is attached to this Element. More...
|
|
bool | isChildRecursive (const String &name) const |
| returns whether at least one window with the given name is attached to this Window or any of it's children as a child. More...
|
|
bool | isAncestor (const String &name) const |
| Return true if the specified element name is a name of some ancestor of this Element. More...
|
|
NamedElement * | getChildElement (const String &name_path) const |
| Return the attached child element that the given name path references. More...
|
|
NamedElement * | getChildElementRecursive (const String &name) const |
| Find the first child with the given name, recursively and breadth-first. More...
|
|
void | removeChild (const String &name_path) |
| Remove the Element referenced by the given name path from this Element's child list. More...
|
|
| Element () |
| Constructor.
|
|
virtual | ~Element () |
| Destructor.
|
|
Element * | getParentElement () const |
| Retrieves parent of this element. More...
|
|
virtual void | setArea (const UVector2 &pos, const USize &size) |
| Set the Element area. More...
|
|
void | setArea (const UDim &xpos, const UDim &ypos, const UDim &width, const UDim &height) |
|
void | setArea (const URect &area) |
|
const URect & | getArea () const |
| Return the element's area. More...
|
|
void | setPosition (const UVector2 &pos) |
| Set the element's position. More...
|
|
void | setXPosition (const UDim &pos) |
|
void | setYPosition (const UDim &pos) |
|
const UVector2 & | getPosition () const |
| Get the element's position. More...
|
|
const UDim & | getXPosition () const |
|
const UDim & | getYPosition () const |
|
virtual void | setHorizontalAlignment (const HorizontalAlignment alignment) |
| Set the horizontal alignment. More...
|
|
HorizontalAlignment | getHorizontalAlignment () const |
| Get the horizontal alignment. More...
|
|
virtual void | setVerticalAlignment (const VerticalAlignment alignment) |
| Set the vertical alignment. More...
|
|
VerticalAlignment | getVerticalAlignment () const |
| Get the vertical alignment. More...
|
|
void | setSize (const USize &size) |
| Set the element's size. More...
|
|
void | setWidth (const UDim &width) |
|
void | setHeight (const UDim &height) |
|
USize | getSize () const |
| Get the element's size. More...
|
|
UDim | getWidth () const |
|
UDim | getHeight () const |
|
void | setMinSize (const USize &size) |
| Set the element's minimum size. More...
|
|
const USize & | getMinSize () const |
| Get the element's minimum size. More...
|
|
void | setMaxSize (const USize &size) |
| Set the element's maximum size. More...
|
|
const USize & | getMaxSize () const |
| Get the element's maximum size. More...
|
|
void | setAspectMode (const AspectMode mode) |
| Sets current aspect mode and recalculates the area rect. More...
|
|
AspectMode | getAspectMode () const |
| Retrieves currently used aspect mode. More...
|
|
void | setAspectRatio (const float ratio) |
| Sets target aspect ratio. More...
|
|
float | getAspectRatio () const |
| Retrieves target aspect ratio. More...
|
|
void | setPixelAligned (const bool setting) |
| Sets whether this Element is pixel aligned (both position and size, basically the 4 "corners"). More...
|
|
bool | isPixelAligned () const |
| Checks whether this Element is pixel aligned. More...
|
|
const Vector2f & | getPixelPosition () const |
| Return the element's absolute (or screen, depending on the type of the element) position in pixels. More...
|
|
const Sizef & | getPixelSize () const |
| Return the element's size in pixels. More...
|
|
Sizef | calculatePixelSize (bool skipAllPixelAlignment=false) const |
| Calculates this element's pixel size. More...
|
|
Sizef | getParentPixelSize (bool skipAllPixelAlignment=false) const |
| Return the pixel size of the parent element. More...
|
|
void | setRotation (const Quaternion &rotation) |
| sets rotation of this widget More...
|
|
const Quaternion & | getRotation () const |
| retrieves rotation of this widget More...
|
|
void | addChild (Element *element) |
| Add the specified Element as a child of this Element. More...
|
|
void | removeChild (Element *element) |
| Remove the Element Element's child list. More...
|
|
Element * | getChildElementAtIdx (size_t idx) const |
| return a pointer to the child element that is attached to 'this' at the given index. More...
|
|
size_t | getChildCount () const |
| Returns number of child elements attached to this Element.
|
|
bool | isChild (const Element *element) const |
| Checks whether given element is attached to this Element.
|
|
bool | isAncestor (const Element *element) const |
| Checks whether the specified Element is an ancestor of this Element. More...
|
|
void | setNonClient (const bool setting) |
| Set whether the Element is non-client. More...
|
|
bool | isNonClient () const |
| Checks whether this element was set to be non client. More...
|
|
const CachedRectf & | getUnclippedOuterRect () const |
| Return a Rect that describes the unclipped outer rect area of the Element. More...
|
|
const CachedRectf & | getUnclippedInnerRect () const |
| Return a Rect that describes the unclipped inner rect area of the Element. More...
|
|
const CachedRectf & | getUnclippedRect (const bool inner) const |
| Return a Rect that describes the unclipped area covered by the Element. More...
|
|
virtual const CachedRectf & | getClientChildContentArea () const |
| Return a Rect that is used by client child elements as content area. More...
|
|
virtual const CachedRectf & | getNonClientChildContentArea () const |
| Return a Rect that is used by client child elements as content area. More...
|
|
const CachedRectf & | getChildContentArea (const bool non_client=false) const |
| Return a Rect that is used to position and size child elements. More...
|
|
virtual void | notifyScreenAreaChanged (bool recursive=true) |
| Inform the element and (optionally) all children that screen area has changed. More...
|
|
virtual const Sizef & | getRootContainerSize () const |
| Return the size of the root container (such as screen size). More...
|
|
| PropertySet (void) |
| Constructs a new PropertySet object.
|
|
virtual | ~PropertySet (void) |
| Destructor for PropertySet objects.
|
|
void | addProperty (Property *property) |
| Adds a new Property to the PropertySet. More...
|
|
void | removeProperty (const String &name) |
| Removes a Property from the PropertySet. More...
|
|
Property * | getPropertyInstance (const String &name) const |
| Retrieves a property instance (that was previously added) More...
|
|
void | clearProperties (void) |
| Removes all Property objects from the PropertySet.
|
|
bool | isPropertyPresent (const String &name) const |
| Checks to see if a Property with the given name is in the PropertySet. More...
|
|
const String & | getPropertyHelp (const String &name) const |
| Return the help text for the specified Property. More...
|
|
String | getProperty (const String &name) const |
| Gets the current value of the specified Property. More...
|
|
template<typename T > |
PropertyHelper< T >::return_type | getProperty (const String &name) const |
| Gets the current value of the specified Property. More...
|
|
void | setProperty (const String &name, const String &value) |
| Sets the current value of a Property. More...
|
|
template<typename T > |
void | setProperty (const String &name, typename PropertyHelper< T >::pass_type value) |
| Sets the current value of a Property. More...
|
|
bool | isPropertyDefault (const String &name) const |
| Returns whether a Property is at it's default value. More...
|
|
String | getPropertyDefault (const String &name) const |
| Returns the default value of a Property as a String. More...
|
|
PropertyIterator | getPropertyIterator (void) const |
| Return a PropertySet::PropertyIterator object to iterate over the available Properties.
|
|
| EventSet () |
| Constructor for EventSet objects.
|
|
virtual | ~EventSet (void) |
| Destructor for EventSet objects.
|
|
void | addEvent (const String &name) |
| Creates a new Event object with the given name and adds it to the EventSet. More...
|
|
void | addEvent (Event &event) |
| Adds the given Event object to the EventSet. Ownership of the object passes to EventSet and it will be deleted when it is removed from the EventSet - whether explicitly via removeEvent or when the EventSet is destroyed. More...
|
|
void | removeEvent (const String &name) |
| Removes the Event with the given name. All connections to the event are disconnected, and the underlying Event object is destroyed. More...
|
|
void | removeEvent (Event &event) |
| Removes the given event from the EventSet. All connections to the event are disconnected, and the event object is destroyed. More...
|
|
void | removeAllEvents (void) |
| Remove all Event objects from the EventSet. Add connections will be disconnected, and all Event objects destroyed.
|
|
bool | isEventPresent (const String &name) |
| Checks to see if an Event with the given name is present in this EventSet. More...
|
|
virtual Event::Connection | subscribeEvent (const String &name, Event::Subscriber subscriber) |
| Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
|
|
virtual Event::Connection | subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber) |
| Subscribes a handler to the specified group of the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
|
|
template<typename Arg1 , typename Arg2 > |
Event::Connection | subscribeEvent (const String &name, Arg1 arg1, Arg2 arg2) |
| Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
|
|
template<typename Arg1 , typename Arg2 > |
Event::Connection | subscribeEvent (const String &name, Event::Group group, Arg1 arg1, Arg2 arg2) |
| Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
|
|
virtual Event::Connection | subscribeScriptedEvent (const String &name, const String &subscriber_name) |
| Subscribes the named Event to a scripted funtion. More...
|
|
virtual Event::Connection | subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name) |
| Subscribes the specified group of the named Event to a scripted funtion. More...
|
|
virtual void | fireEvent (const String &name, EventArgs &args, const String &eventNamespace="") |
| Fires the named event passing the given EventArgs object. More...
|
|
bool | isMuted (void) const |
| Return whether the EventSet is muted or not. More...
|
|
void | setMutedState (bool setting) |
| Set the mute state for this EventSet. More...
|
|
Event * | getEventObject (const String &name, bool autoAdd=false) |
| Return a pointer to the Event object with the given name, optionally adding such an Event object to the EventSet if it does not already exist. More...
|
|
EventIterator | getEventIterator (void) const |
| Return a EventSet::EventIterator object to iterate over the events currently added to the EventSet.
|
|
Adds name to the Element class, including name path traversal.
- Name path
- A name path is a string that describes a path down the element hierarchy using names and the forward slash '/' as a separator. For example, if this element has a child attached to it named "Panel" which has its own children attached named "Okay" and "Cancel", you can check for the element "Okay" from this element by using the name path "Panel/Okay". To check for "Panel", you would simply pass the name "Panel".
- See also
- Element