|
virtual eC_Bool | DoScale (const eC_Value &vDelta) |
|
virtual eC_Bool | DoUserEvent (CGUIEvent *const pEvent) |
|
virtual void | OnCreate () |
|
virtual void | OnDataPool (const DataPoolResource_t &eID) |
|
virtual void | OnDelete () |
|
virtual void | OnHide () |
|
virtual void | OnShow () |
|
|
virtual eC_Bool | DoClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1)) |
|
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 | DoScroll (const eC_Value &vAbsX, const eC_Value &vAbsY, const eC_Value &vDelta, const eC_Bool &bModifierActive) |
|
const eC_String & | GetXMLTag () const |
|
virtual void | ReadFromStream () |
|
void | SetXMLTag (const eC_String &kXMLTag) |
|
virtual void | WriteToStream (const eC_Bool bWriteClassID=false) |
|
CGUIBehaviour base class.
The methods of CGUIBehaviour define Guiliani's standard event handling slots. These slots will be called by CGUIEventHandler automatically in response to specific user actions. (see Mappings from events to event handling slots for the detailed information of events to handling methods).
Also, please refer to Exemplary sequence of events for further information.
Thus, if a control needs special handling for the associated events it can reimplement the corresponding slots with the desired functionality. When inheriting customized controls from Guiliani's standard set of widgets, it is advisable to call the base-class implementation of the overwritten method. Failure to do so may break the base classes default behaviour.
virtual eC_Bool CGUIBehaviour::DoButtonDown |
( |
const eC_Value & |
vAbsX = eC_FromInt(-1) , |
|
|
const eC_Value & |
vAbsY = eC_FromInt(-1) |
|
) |
| |
|
virtual |
Called when the mouse button or finger is pressed down over an object.
- Note
- DoButtonDown() 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 the object in a newer and probably intermediate state that he currently does not see in this state. Thus, to calculate the relative position (where the object was pressed 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 always returns False.
Reimplemented in CGUIAutoRepeatBehaviour, CGUICmdBehaviour, CGUICompositeBehaviour, CGUIBaseInputField, CGUIBaseMessageBox, CGUIBaseSlider, CGUICalendar, CGUIChart, CGUICircularSlider, CGUIEdit, CGUIImageStack, CGUIListBox, CGUIPageContainer, CGUIRadialSlider, CGUIRangeSlider, CGUIScrollBar, CGUISegmentBar, CGUISplitContainer, CGUITouchScrollView, CGUIWheel, CGUIWheelContainer, CGUIBaseButton, CGUIOnscreenKeyboard, and CGUIPrimitiveButton.
virtual eC_Bool CGUIBehaviour::DoButtonUp |
( |
const eC_Value & |
vAbsX = eC_FromInt(-1) , |
|
|
const eC_Value & |
vAbsY = eC_FromInt(-1) |
|
) |
| |
|
virtual |
Called when the mouse button or finger is released. The object under the mouse at the time of releasing will receive this event.
- Note
- DoButtonUp() 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 in this state. Thus, to calculate the relative position (where the button was released 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 mouse was released. |
vAbsY | Y-position in screen coordinates where the mouse was released. |
- Returns
- True The event has been handled.
False The event has not been handled. In this base implementation always returns False.
Reimplemented in CGUIAutoRepeatBehaviour, CGUICmdBehaviour, CGUICompositeBehaviour, CGUIKeyboardBehaviour, CGUISplitContainer, CGUIBaseButton, CGUIOnscreenKeyboard, and CGUIPrimitiveButton.
virtual eC_Bool CGUIBehaviour::DoClick |
( |
const eC_Value & |
vAbsX = eC_FromInt(-1) , |
|
|
const eC_Value & |
vAbsY = eC_FromInt(-1) |
|
) |
| |
|
virtual |
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 in CGUIAutoRepeatBehaviour, CGUIKeyboardBehaviour, CGUIObjectStateBehaviour, CGUIObjectVisualsBehaviour, CGUITabSwitchBehaviour, CGUIBaseCheckBox, CGUIBaseMessageBox, CGUIBaseRadioButton, CGUIBaseSlider, CGUICalendar, CGUIChart, CGUICircularSlider, CGUIPageContainer, CGUIRadialSlider, CGUIRadioButtonGroup, CGUIRangeSlider, CGUIScrollBar, CGUISegmentBar, CGUITabItemBehaviour, CGUITouchScrollView, CGUIWheel, CGUIListBox, CGUICmdBehaviour, CGUICompositeBehaviour, CGUIBaseButton, CGUIComboBox, CGUIExpandingCompositeBehaviour, CGUIPrimitiveButton, and CGUIInputCalibration.
virtual eC_Bool CGUIBehaviour::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 |
Called when the object receives a Drag event. Drags are typically created if the mouse is being used while a mouse-button is being pressed, or if the user moves his finger over a touchscreen.
- Parameters
-
vDeltaX | relative movement in x-direction since the last call of DoDrag/ButtonDown |
vDeltaY | relative movement in y-direction since the last call of DoDrag/ButtonDown |
vAbsX | current X-position in screen coordinates of the mouse |
vAbsY | current Y-position in screen coordinates of the mouse |
- Returns
- True If the event has been handled.
false Else.
Reimplemented in CGUICmdBehaviour, CGUICompositeBehaviour, CGUIBaseMessageBox, CGUIBaseSlider, CGUICalendar, CGUICarousel, CGUICenterFocusContainer, CGUIChart, CGUICircularSlider, CGUIEdit, CGUIGraph, CGUIImageStack, CGUIKnob, CGUIListBox, CGUIPageContainer, CGUIPlot, CGUIPrimitiveButton, CGUIRadialSlider, CGUIRangeSlider, CGUISegmentBar, CGUISplitContainer, CGUITouchScrollView, CGUIWheel, CGUIWheelContainer, and CGUIOnscreenKeyboard.
virtual eC_Bool CGUIBehaviour::DoDragEnd |
( |
const eC_Value & |
vAbsX = eC_FromInt(-1) , |
|
|
const eC_Value & |
vAbsY = eC_FromInt(-1) |
|
) |
| |
|
virtual |
Called on the dragged object (=the object on which the initial ButtonDown-event occurred) when the mouse button is released after a drag event.
- Parameters
-
vAbsX | current X-position in screen coordinates of the mouse |
vAbsY | current Y-position in screen coordinates of the mouse |
- Returns
- True If the event has been handled.
false Else.
Reimplemented in CGUIAutoRepeatBehaviour, CGUICmdBehaviour, CGUICompositeBehaviour, CGUIBaseSlider, CGUICalendar, CGUICarousel, CGUICenterFocusContainer, CGUIChart, CGUICircularSlider, CGUIKnob, CGUIListBox, CGUIPageContainer, CGUIRadialSlider, CGUIRangeSlider, CGUIScrollBar, CGUISplitContainer, CGUITouchScrollView, CGUIWheel, CGUIWheelContainer, and CGUIPrimitiveButton.
virtual eC_Bool CGUIBehaviour::DoKeyDown |
( |
const GUIKeyIdentifier_t & |
eKeyIdentifier, |
|
|
const eC_UInt & |
uiModifiers |
|
) |
| |
|
virtual |
virtual eC_Bool CGUIBehaviour::FocusPrevious |
( |
CGUIObject *const |
pRefObj = NULL , |
|
|
const eC_Bool & |
bSubTreeOfRefObjDone = false |
|
) |
| |
|
virtual |
Called when the object is requested to focus the "previous" object. Typically, this happens in reaction to a standard GK_UP event or by request from Source-Code. For a simple object there is nothing to do but to indicate that the event has not been handled. For a standardized event handling mechanism, this method must exist.
- Parameters
-
pRefObj | usually is a child of this object which indicates the current position in the child list. |
bSubTreeOfRefObjDone | indicates if the subtree that is under pRefObj has already been asked to take focus, or if not. |
- Returns
- True If the event has been handled.
false Else.
Reimplemented in CGUICmdBehaviour, CGUICompositeBehaviour, CGUICompositeObject, and CGUIObject.