CGUITabItemBehaviour Class Reference
Behaviour to switch between the children of a tab-container. More...
#include <GUITabContainer.h>
Inheritance diagram for CGUITabItemBehaviour:
Public Member Functions | |
| CGUITabItemBehaviour () | |
| Default constructor. | |
| CGUITabItemBehaviour (const eC_UInt &uiTabItemIndex) | |
| void | SetContainer (CGUICompositeObject *pkContainer) |
 Public Member Functions inherited from CGUIBehaviourDecorator | |
| virtual | ~CGUIBehaviourDecorator () |
| virtual CGUIBehaviourDecorator * | Clone () const |
| virtual eC_Bool | IsCompositeBehaviour () const |
| Public Member Functions inherited from CGUIBehaviour | |
| virtual eC_Bool | DoUserEvent (CGUIEvent *const pEvent) |
| virtual void | OnCreate () |
| virtual void | OnDelete () |
| virtual void | OnHide () |
| virtual void | OnShow () |
| virtual eC_Bool | DoLongClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1)) |
| virtual eC_Bool | DoDoubleClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1)) |
| virtual eC_Bool | DoButtonDown (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1)) |
| virtual eC_Bool | DoButtonUp (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1)) |
| virtual eC_Bool | DoDrag (const eC_Value &vDeltaX=eC_FromInt(-1), const eC_Value &vDeltaY=eC_FromInt(-1), const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1)) |
| virtual eC_Bool | DoDragEnd (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1)) |
| virtual eC_Bool | DoMouseEnter (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1)) |
| virtual eC_Bool | DoMouseLeave (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1)) |
| virtual eC_Bool | DoMouseMove (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1)) |
| virtual eC_Bool | FocusPrevious (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false) |
| virtual eC_Bool | FocusNext (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false) |
| virtual void | GetFocus () |
| virtual void | LoseFocus () |
| virtual eC_Bool | Decrease () |
| virtual eC_Bool | Increase () |
| virtual eC_Bool | DoKeyDown (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers) |
| virtual eC_Bool | DoKeyUp (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers) |
| virtual eC_Bool | DoChar (const eC_UInt &uiKey, const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers) |
| virtual eC_Bool | DoScrollUp (const eC_Value &vAbsX, const eC_Value &vAbsY) |
| virtual eC_Bool | DoScrollDown (const eC_Value &vAbsX, const eC_Value &vAbsY) |
| virtual eC_Bool | DoScrollLeft (const eC_Value &vAbsX, const eC_Value &vAbsY) |
| virtual eC_Bool | DoScrollRight (const eC_Value &vAbsX, const eC_Value &vAbsY) |
| Public Member Functions inherited from CGUIStreamableObject | |
| const eC_String & | GetXMLTag () const |
| virtual void | ReadFromStream () |
| void | SetXMLTag (const eC_String &kXMLTag) |
| virtual void | WriteToStream (const eC_Bool bWriteClassID=false) |
Protected Member Functions | |
| virtual eC_Bool | DoClick (const eC_Value &vAbsX, const eC_Value &vAbsY) |
| Protected Member Functions inherited from CGUIBehaviourDecorator | |
| CGUIBehaviourDecorator (CGUIObject *const pkObject=NULL) | |
| CGUIBehaviourDecorator (const CGUIBehaviourDecorator &kSource) | |
| virtual void | AssociatedObjectChanges (CGUIObject *const pkNewAssociatedObject) |
| CGUIObject * | GetAssociatedObject () const |
| Protected Member Functions inherited from CGUIStreamableObject | |
| eC_UInt | ReadStreamingHeader (const eC_UInt &uiClassVersion, const eC_UInt &uiClassMinVersion=0) const |
| void | WriteStreamingFooter (const eC_Bool &bWriteClassID) const |
| void | WriteStreamingHeader (const eC_Bool &bWriteClassID, const eC_Char *const pkClassIDTag, const eC_Int &iClassID, const eC_UInt &uiClassVersion) const |
Additional Inherited Members | |
| Static Public Attributes inherited from CGUIBehaviour | |
| static const eC_Char | XMLTAG_BEHAVIOURCLASSID [] |
| XML tag to be used when writing a behaviour class ID into a stream. | |
| Static Public Attributes inherited from CGUIStreamableObject | |
| static const eC_Char | XMLTAG_CLASSVERSION [] |
Detailed Description
Behaviour to switch between the children of a tab-container.
Constructor & Destructor Documentation
◆ CGUITabItemBehaviour()
| CGUITabItemBehaviour::CGUITabItemBehaviour | ( | const eC_UInt & | uiTabItemIndex | ) |
Constructor
- Parameters
-
uiTabItemIndex the child-index which will be activated when using the behaviour
Member Function Documentation
◆ DoClick()
|
protectedvirtual |
Called when the object receives a click event. A click can e.g., be the result of a mouse click, a finger press/release sequence on touchscreens, or be triggered by a GK_ACTION keyboard event.
- Note
- DoClick() should work on the absolute positions of this object, that were set at the time of the passed redraw, as the user expects to click on what he sees and not to click on an object in a newer and probably intermediate state that he currently does not see. Thus, to calculate the relative position (where the mouse button was pressed and released at the same position for in a certain time span, relative to the origin of this object) from the vAbsY argument you must do it like this: vMyRelYPos = vAbsY - GetAbsYPos().
- Parameters
-
vAbsX X-position in screen coordinates where the click occurred vAbsY Y-position in screen coordinates where the click occurred
- Returns
- True The event has been handled.
False The event has not been handled. In this base implementation it always returns False.
Reimplemented from CGUIBehaviour.
◆ SetContainer()
| void CGUITabItemBehaviour::SetContainer | ( | CGUICompositeObject * | pkContainer | ) |
Set the attached container
- Parameters
-
pkContainer
The documentation for this class was generated from the following file:
