hollyhock
Public Types | Public Member Functions | List of all members
GUIDropDownMenu Class Reference
Inheritance diagram for GUIDropDownMenu:
Inheritance graph
[legend]
Collaboration diagram for GUIDropDownMenu:
Collaboration graph
[legend]

Public Types

enum  ScrollBarVisibility : uint32_t { ScrollBarHidden = 0 , ScrollBarAlwaysVisible = 1 , ScrollBarVisibleWhenRequired = 2 }
 

Public Member Functions

 GUIDropDownMenu (uint16_t leftX, uint16_t topY, uint16_t rightX, uint16_t bottomY, uint16_t eventID)
 
void SetScrollBarVisibility (ScrollBarVisibility visibility)
 
void AddMenuItem (GUIDropDownMenuItem &dropDownMenuItem)
 
- Public Member Functions inherited from Wrapped
template<typename T >
T * GetWrapped ()
 

Additional Inherited Members

- Protected Member Functions inherited from Wrapped
 Wrapped (Wrapped const &)=delete
 
void operator= (Wrapped const &)=delete
 
- Protected Attributes inherited from Wrapped
void * m_wrapped
 A pointer to the wrapped class.
 

Member Enumeration Documentation

◆ ScrollBarVisibility

Enumerator
ScrollBarHidden 

Always hide the scroll bar.

ScrollBarAlwaysVisible 

Always show the scroll bar.

ScrollBarVisibleWhenRequired 

Only show the scroll bar when required.

Constructor & Destructor Documentation

◆ GUIDropDownMenu()

GUIDropDownMenu::GUIDropDownMenu ( uint16_t  leftX,
uint16_t  topY,
uint16_t  rightX,
uint16_t  bottomY,
uint16_t  eventID 
)

Creates a drop down menu.

The bounds do not effect the height of the normally visible part of the menu, but are used to set the height of the menu which appears when the drop down menu is selected.

Parameters
leftX,topY,rightX,bottomYThe coordinates of the bounding box of the drop down menu, in screen pixels relative to the top left of the display.
eventIDThe ID to use for events relating to this drop down menu.

Member Function Documentation

◆ AddMenuItem()

void GUIDropDownMenu::AddMenuItem ( GUIDropDownMenuItem dropDownMenuItem)

Adds an item to the drop down menu.

Parameters
Theitem to add.

◆ SetScrollBarVisibility()

void GUIDropDownMenu::SetScrollBarVisibility ( ScrollBarVisibility  visibility)

Sets the visibility of the scroll bar.

Parameters
visibilityThe visibility of the scroll bar.

The documentation for this class was generated from the following files: