GuiBar Class Reference
The GuiBar class provides a widget for bars. More...
#include <jmGuiWidgetsA.h>
Inherits GuiWidget.
Public Member Functions | |
| GuiBar (Sprite *_sprite) | |
| Construct a new gui bar from the given *_sprite*. More... | |
| void | SetValue (float _value) |
| Set the value of this bar. More... | |
| float | GetValue () |
| Returns the value of this bar. More... | |
| int | GetIntValue () |
| Returns the value of this bar rounded to integer. More... | |
| void | SetValueMin (float _valueMin) |
| Set the minimum value of this bar. More... | |
| float | GetValueMin () |
| Returns the minimum value of this bar. More... | |
| void | SetValueMax (float _valueMax) |
| Set the maximum value of this bar. More... | |
| float | GetValueMax () |
| Returns the maximum value of this bar. More... | |
 Public Member Functions inherited from GuiWidget | |
| bool | IsCursorDown () |
| Returns true if the cursor is hold down over this widget; otherwise returns false. More... | |
| bool | IsCursorOver () |
| Returns true if the cursor is over this widget; otherwise returns false. More... | |
| bool | IsPressed () |
| Returns true if the cursor is pressed while over this widget; otherwise returns false. More... | |
| bool | IsValueChanged () |
| Returns true if this widget's value is changed; otherwise returns false. More... | |
| virtual void | SetDisabled (bool _disabled) |
| Set the disabled state of this widget. More... | |
| bool | IsDisabled () |
| Returns true if this widget is disabled; otherwise returns false. More... | |
| virtual void | SetVisible (bool _visible) |
| Set the visibility of this widget. More... | |
| bool | IsVisible () |
| Returns true if this widget is visible; otherwise returns false. More... | |
| void | SetName (const std::string &_name) |
| Set the name of this widget. More... | |
| std::string | GetName () |
| Returns the name of this widget. More... | |
| void | SetTag (int _tag) |
| Set the tag of this widget. More... | |
| int | GetTag () |
| Returns the tag of this widget. More... | |
| GuiWidgetKind | GetKind () |
| Returns the kind of this widget. More... | |
| std::string | GetDesignKind () |
| Returns the design kind of this widget. More... | |
| void | AssignCustomObject (CustomObject *_customObject) |
| Assign the given *_customObject* to this widget. More... | |
| CustomObject * | GetCustomObject () |
| Returns the custom object of this widget or nullptr if none. More... | |
| void | AssignCallback (GuiWidgetCallback *_callback) |
| Assign the given *_callback* to this widget. More... | |
| GuiWidgetCallback * | GetCallback () |
| Returns the callback of this widget or nullptr if none. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from GuiWidget | |
| static GuiWidget * | GetInteracted () |
| Returns the interacted widget. More... | |
| static GuiWidget * | GetInteracted (const std::string &_name) |
| Returns the interacted widget with the given *_name*. More... | |
| static GuiWidget * | GetInteracted (int _tag) |
| Returns the interacted widget with the given *_tag*. More... | |
| static GuiWidget * | GetInteracted (CustomObject *_customObject) |
| Returns the interacted widget which has assigned the given *_customObject*. More... | |
| static GuiWidget * | GetInteracted_Pressed () |
| Returns the interacted widget which is pressed. More... | |
| static GuiWidget * | GetInteracted_Pressed (const std::string &_name) |
| Returns the interacted widget with the given *_name* which is pressed. More... | |
| static GuiWidget * | GetInteracted_Pressed (int _tag) |
| Returns the interacted widget with the given *_tag* which is pressed. More... | |
| static GuiWidget * | GetInteracted_Pressed (CustomObject *_customObject) |
| Returns the interacted widget with assigned *_customObject* which is pressed. More... | |
| static GuiWidget * | GetInteracted_ValueChanged () |
| Returns the interacted widget which has changed value. More... | |
| static GuiWidget * | GetInteracted_ValueChanged (const std::string &_name) |
| Returns the interacted widget with the given *_name* which has changed value. More... | |
| static GuiWidget * | GetInteracted_ValueChanged (int _tag) |
| Returns the interacted widget with the given *_tag* which has changed value. More... | |
| static GuiWidget * | GetInteracted_ValueChanged (CustomObject *_customObject) |
| Returns the interacted widget with assigned *_customObject* which has changed value. More... | |
| static GuiWidget * | GetInteracted_CursorOver () |
| Returns the interacted widget which has the cursor over. More... | |
| static GuiWidget * | GetInteracted_CursorOver (const std::string &_name) |
| Returns the interacted widget with the given *_name* which has the cursor over. More... | |
| static GuiWidget * | GetInteracted_CursorOver (int _tag) |
| Returns the interacted widget with the given *_tag* which has the cursor over. More... | |
| static GuiWidget * | GetInteracted_CursorOver (CustomObject *_customObject) |
| Returns the interacted widget with assigned *_customObject* which has the cursor over. More... | |
| static GuiWidget * | GetInteracted_cursorDown () |
| Returns the interacted widget which has the cursor hold down. More... | |
| static GuiWidget * | GetInteracted_CursorDown (const std::string &_name) |
| Returns the interacted widget with the given *_name* which has the cursor hold down. More... | |
| static GuiWidget * | GetInteracted_CursorDown (int _tag) |
| Returns the interacted widget with the given *_tag* which has the cursor hold down. More... | |
| static GuiWidget * | GetInteracted_CursorDown (CustomObject *_customObject) |
| Returns the interacted widget with assigned *_customObject* which has the cursor hold down. More... | |
Detailed Description
The GuiBar class provides a widget for bars.
A bar is a visual representation of values in range.
Constructor & Destructor Documentation
◆ GuiBar()
Construct a new gui bar from the given *_sprite*.
The bar properties are obtained from the sprite custom parameters.
Member Function Documentation
◆ SetValue()
| void SetValue | ( | float | _value | ) |
Set the value of this bar.
◆ GetValue()
|
inline |
Returns the value of this bar.
◆ GetIntValue()
|
inline |
Returns the value of this bar rounded to integer.
◆ SetValueMin()
| void SetValueMin | ( | float | _valueMin | ) |
Set the minimum value of this bar.
◆ GetValueMin()
|
inline |
Returns the minimum value of this bar.
◆ SetValueMax()
| void SetValueMax | ( | float | _valueMax | ) |
Set the maximum value of this bar.
◆ GetValueMax()
|
inline |
Returns the maximum value of this bar.
The documentation for this class was generated from the following files:
- C:/Development/JugiMapProject/JugiMapFRM/framework_c++/jugimap/jmGuiWidgetsA.h
- C:/Development/JugiMapProject/JugiMapFRM/framework_c++/jugimap/jmGuiWidgetsA.cpp
