Public Member Functions | |
| MenuItem (const std::string &text, int id=-1) | |
| int | get_id () const |
| void | set_help (const std::string &help_text) |
| const std::string & | get_help () const |
| void | set_text (const std::string &text) |
| const std::string & | get_text () const |
| void | set_font (const FontPtr font) |
| const FontPtr & | get_font () const |
| virtual void | draw (DrawingContext &, const Vector &pos, int menu_width, bool active) |
| Draws the menu item. More... | |
| virtual void | on_window_resize () |
| virtual bool | skippable () const |
| Returns true when the menu item has no action and therefore can be skipped. More... | |
| virtual float | get_distance () const |
| Returns the distance between the items above and below the current menu item. More... | |
| virtual int | get_width () const |
| Returns the minimum width of the menu item. More... | |
| virtual int | get_height () const |
| Returns height of menu item. More... | |
| virtual void | process_action (const MenuAction &action) |
| Processes the menu action. More... | |
| virtual void | event (const SDL_Event &ev) |
| Processes the given event. More... | |
| virtual Color | get_color () const |
| virtual bool | no_other_action () const |
| Returns true when the MenuManager shouldn't do anything else. More... | |
| virtual bool | changes_width () const |
| Returns true when the width must be recalculated when an action is processed. | |
| virtual bool | select_blink () const |
| Returns true when the item should have a blink effect, provided by the menu, when active. More... | |
Member Function Documentation
◆ draw()
|
virtual |
Draws the menu item.
Reimplemented in ItemColorChannelOKLab, ItemHorizontalMenu, ItemToggle, ItemColorChannelRGBA, ItemStringSelect, ItemColorDisplay, ItemImages, ItemScriptLine, ItemTextField, ItemBack, ItemControlField, ItemHorizontalLine, and ItemLabel.
◆ event()
|
inlinevirtual |
Processes the given event.
Reimplemented in ItemColorChannelOKLab, ItemHorizontalMenu, ItemTextField, ItemColorChannelRGBA, and ItemScriptLine.
◆ get_distance()
|
inlinevirtual |
Returns the distance between the items above and below the current menu item.
Reimplemented in ItemHorizontalMenu.
◆ get_height()
|
inlinevirtual |
Returns height of menu item.
Reimplemented in ItemHorizontalMenu, and ItemImages.
◆ get_width()
|
virtual |
Returns the minimum width of the menu item.
Reimplemented in ItemHorizontalMenu, ItemColorChannelOKLab, ItemToggle, ItemHorizontalLine, ItemLabel, ItemColorChannelRGBA, ItemStringSelect, ItemColorDisplay, ItemScriptLine, ItemTextField, ItemBack, ItemControlField, and ItemImages.
◆ no_other_action()
|
inlinevirtual |
Returns true when the MenuManager shouldn't do anything else.
Reimplemented in ItemBack.
◆ process_action()
|
inlinevirtual |
Processes the menu action.
Reimplemented in ItemColorChannelOKLab, ItemHorizontalMenu, ItemToggle, ItemColorChannelRGBA, ItemStringSelect, ItemScriptLine, ItemTextField, ItemBack, ItemImages, ItemColor, ItemList, ItemPaths, ItemGoTo, ItemScript, ItemStringArray, and ItemAction.
◆ select_blink()
|
inlinevirtual |
Returns true when the item should have a blink effect, provided by the menu, when active.
Reimplemented in ItemHorizontalMenu.
◆ skippable()
|
inlinevirtual |
Returns true when the menu item has no action and therefore can be skipped.
Useful for labels and horizontal lines.
Reimplemented in ItemColorDisplay, ItemInactive, ItemHorizontalLine, and ItemLabel.
The documentation for this class was generated from the following files:
- src/gui/menu_item.hpp
- src/gui/menu_item.cpp
