arsa
2.7
|
Default scroll bar GUI element. More...
#include <IGUIScrollBar.h>
Public Member Functions | |
IGUIScrollBar (IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect< s32 > rectangle) | |
constructor More... | |
virtual void | setMax (s32 max)=0 |
sets the maximum value of the scrollbar. More... | |
virtual s32 | getMax () const =0 |
gets the maximum value of the scrollbar. More... | |
virtual void | setMin (s32 min)=0 |
sets the minimum value of the scrollbar. More... | |
virtual s32 | getMin () const =0 |
gets the minimum value of the scrollbar. More... | |
virtual s32 | getSmallStep () const =0 |
gets the small step value More... | |
virtual void | setSmallStep (s32 step)=0 |
Sets the small step. More... | |
virtual s32 | getLargeStep () const =0 |
gets the large step value More... | |
virtual void | setLargeStep (s32 step)=0 |
Sets the large step. More... | |
virtual s32 | getPos () const =0 |
gets the current position of the scrollbar More... | |
virtual void | setPos (s32 pos)=0 |
sets the current position of the scrollbar More... | |
Public Member Functions inherited from irr::gui::IGUIElement | |
IGUIElement (EGUI_ELEMENT_TYPE type, IGUIEnvironment *environment, IGUIElement *parent, s32 id, const core::rect< s32 > &rectangle) | |
Constructor. More... | |
virtual | ~IGUIElement () |
Destructor. More... | |
IGUIElement * | getParent () const |
Returns parent of this element. More... | |
core::rect< s32 > | getRelativePosition () const |
Returns the relative rectangle of this element. More... | |
void | setRelativePosition (const core::rect< s32 > &r) |
Sets the relative rectangle of this element. More... | |
void | setRelativePosition (const core::position2di &position) |
Sets the relative rectangle of this element, maintaining its current width and height. More... | |
void | setRelativePositionProportional (const core::rect< f32 > &r) |
Sets the relative rectangle of this element as a proportion of its parent's area. More... | |
core::rect< s32 > | getAbsolutePosition () const |
Gets the absolute rectangle of this element. More... | |
core::rect< s32 > | getAbsoluteClippingRect () const |
Returns the visible area of the element. More... | |
void | setNotClipped (bool noClip) |
Sets whether the element will ignore its parent's clipping rectangle. More... | |
bool | isNotClipped () const |
Gets whether the element will ignore its parent's clipping rectangle. More... | |
void | setMaxSize (core::dimension2du size) |
Sets the maximum size allowed for this element. More... | |
void | setMinSize (core::dimension2du size) |
Sets the minimum size allowed for this element. More... | |
void | setAlignment (EGUI_ALIGNMENT left, EGUI_ALIGNMENT right, EGUI_ALIGNMENT top, EGUI_ALIGNMENT bottom) |
The alignment defines how the borders of this element will be positioned when the parent element is resized. More... | |
virtual void | updateAbsolutePosition () |
Updates the absolute position. More... | |
virtual IGUIElement * | getElementFromPoint (const core::position2d< s32 > &point) |
Returns the topmost GUI element at the specific position. More... | |
virtual bool | isPointInside (const core::position2d< s32 > &point) const |
Returns true if a point is within this element. More... | |
virtual void | addChild (IGUIElement *child) |
Adds a GUI element as new child of this element. More... | |
virtual void | removeChild (IGUIElement *child) |
Removes a child. More... | |
virtual void | remove () |
Removes this element from its parent. More... | |
virtual void | draw () |
Draws the element and its children. More... | |
virtual void | OnPostRender (u32 timeMs) |
animate the element and its children. More... | |
virtual void | move (core::position2d< s32 > absoluteMovement) |
Moves this element. More... | |
virtual bool | isVisible () const |
Returns true if element is visible. More... | |
virtual bool | isTrulyVisible () const |
Check whether the element is truly visible, taking into accounts its parents' visibility. More... | |
virtual void | setVisible (bool visible) |
Sets the visible state of this element. More... | |
virtual bool | isSubElement () const |
Returns true if this element was created as part of its parent control. More... | |
virtual void | setSubElement (bool subElement) |
Sets whether this control was created as part of its parent. More... | |
void | setTabStop (bool enable) |
If set to true, the focus will visit this element when using the tab key to cycle through elements. More... | |
bool | isTabStop () const |
Returns true if this element can be focused by navigating with the tab key. More... | |
void | setTabOrder (s32 index) |
Sets the priority of focus when using the tab key to navigate between a group of elements. More... | |
s32 | getTabOrder () const |
Returns the number in the tab order sequence. More... | |
void | setTabGroup (bool isGroup) |
Sets whether this element is a container for a group of elements which can be navigated using the tab key. More... | |
bool | isTabGroup () const |
Returns true if this element is a tab group. More... | |
IGUIElement * | getTabGroup () |
Returns the container element which holds all elements in this element's tab group. More... | |
virtual bool | isEnabled () const |
Returns true if element is enabled. More... | |
virtual void | setEnabled (bool enabled) |
Sets the enabled state of this element. More... | |
virtual void | setText (const wchar_t *text) |
Sets the new caption of this element. More... | |
virtual const wchar_t * | getText () const |
Returns caption of this element. More... | |
virtual void | setToolTipText (const wchar_t *text) |
Sets the new caption of this element. More... | |
virtual const core::stringw & | getToolTipText () const |
Returns caption of this element. More... | |
virtual s32 | getID () const |
Returns id. Can be used to identify the element. More... | |
virtual void | setID (s32 id) |
Sets the id of this element. More... | |
virtual bool | OnEvent (const SEvent &event) _IRR_OVERRIDE_ |
Called if an event happened. More... | |
virtual bool | bringToFront (IGUIElement *element) |
Brings a child to front. More... | |
virtual bool | sendToBack (IGUIElement *child) |
Moves a child to the back, so it's siblings are drawn on top of it. More... | |
virtual const core::list< IGUIElement * > & | getChildren () const |
Returns list with children of this element. More... | |
virtual IGUIElement * | getElementFromId (s32 id, bool searchchildren=false) const |
Finds the first element with the given id. More... | |
bool | isMyChild (IGUIElement *child) const |
bool | getNextElement (s32 startOrder, bool reverse, bool group, IGUIElement *&first, IGUIElement *&closest, bool includeInvisible=false, bool includeDisabled=false) const |
searches elements to find the closest next element to tab to More... | |
EGUI_ELEMENT_TYPE | getType () const |
Returns the type of the gui element. More... | |
virtual bool | hasType (EGUI_ELEMENT_TYPE type) const |
Returns true if the gui element supports the given type. More... | |
virtual const c8 * | getTypeName () const |
Returns the type name of the gui element. More... | |
virtual const c8 * | getName () const |
Returns the name of the element. More... | |
virtual void | setName (const c8 *name) |
Sets the name of the element. More... | |
virtual void | setName (const core::stringc &name) |
Sets the name of the element. More... | |
virtual void | serializeAttributes (io::IAttributes *out, io::SAttributeReadWriteOptions *options=0) const _IRR_OVERRIDE_ |
Writes attributes of the scene node. More... | |
virtual void | deserializeAttributes (io::IAttributes *in, io::SAttributeReadWriteOptions *options=0) _IRR_OVERRIDE_ |
Reads attributes of the scene node. More... | |
Public Member Functions inherited from irr::IReferenceCounted | |
IReferenceCounted () | |
Constructor. More... | |
virtual | ~IReferenceCounted () |
Destructor. More... | |
void | grab () const |
Grabs the object. Increments the reference counter by one. More... | |
bool | drop () const |
Drops the object. Decrements the reference counter by one. More... | |
s32 | getReferenceCount () const |
Get the reference count. More... | |
const c8 * | getDebugName () const |
Returns the debug name of the object. More... | |
Public Member Functions inherited from irr::IEventReceiver | |
virtual | ~IEventReceiver () |
Destructor. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from irr::gui::IGUIElement | |
void | addChildToEnd (IGUIElement *child) |
void | recalculateAbsolutePosition (bool recursive) |
Protected Member Functions inherited from irr::IReferenceCounted | |
void | setDebugName (const c8 *newName) |
Sets the debug name of the object. More... | |
Protected Attributes inherited from irr::gui::IGUIElement | |
core::list< IGUIElement * > | Children |
List of all children of this element. More... | |
IGUIElement * | Parent |
Pointer to the parent. More... | |
core::rect< s32 > | RelativeRect |
relative rect of element More... | |
core::rect< s32 > | AbsoluteRect |
absolute rect of element More... | |
core::rect< s32 > | AbsoluteClippingRect |
absolute clipping rect of element More... | |
core::rect< s32 > | DesiredRect |
core::rect< s32 > | LastParentRect |
for calculating the difference when resizing parent More... | |
core::rect< f32 > | ScaleRect |
relative scale of the element inside its parent More... | |
core::dimension2du | MaxSize |
maximum and minimum size of the element More... | |
core::dimension2du | MinSize |
bool | IsVisible |
is visible? More... | |
bool | IsEnabled |
is enabled? More... | |
bool | IsSubElement |
is a part of a larger whole and should not be serialized? More... | |
bool | NoClip |
does this element ignore its parent's clipping rectangle? More... | |
core::stringw | Text |
caption More... | |
core::stringw | ToolTipText |
tooltip More... | |
core::stringc | Name |
users can set this for identifying the element by string More... | |
s32 | ID |
users can set this for identifying the element by integer More... | |
bool | IsTabStop |
tab stop like in windows More... | |
s32 | TabOrder |
tab order More... | |
bool | IsTabGroup |
tab groups are containers like windows, use ctrl+tab to navigate More... | |
EGUI_ALIGNMENT | AlignLeft |
tells the element how to act when its parent is resized More... | |
EGUI_ALIGNMENT | AlignRight |
EGUI_ALIGNMENT | AlignTop |
EGUI_ALIGNMENT | AlignBottom |
IGUIEnvironment * | Environment |
GUI Environment. More... | |
EGUI_ELEMENT_TYPE | Type |
type of element More... | |
Default scroll bar GUI element.
Definition at line 19 of file IGUIScrollBar.h.
|
inline |
constructor
Definition at line 24 of file IGUIScrollBar.h.
|
pure virtual |
gets the large step value
|
pure virtual |
gets the maximum value of the scrollbar.
|
pure virtual |
gets the minimum value of the scrollbar.
|
pure virtual |
gets the current position of the scrollbar
|
pure virtual |
gets the small step value
Sets the large step.
That is the amount that the value changes by when clicking in the tray, or using the page up and page down keys.
sets the maximum value of the scrollbar.
sets the minimum value of the scrollbar.
sets the current position of the scrollbar
Sets the small step.
That is the amount that the value changes by when clicking on the buttons or using the cursor keys.