Public Types | Public Member Functions | List of all members
PopupMenu::Options Class Reference

Class used to create a set of options to pass to the show() method. More...

Public Types

enum  PopupDirection { PopupDirection::upwards, PopupDirection::downwards }
 

Public Member Functions

 Options ()
 
 Options (const Options &)=default
 
Optionsoperator= (const Options &)=default
 
Options withTargetComponent (Component *targetComponent) const noexcept
 
Options withTargetScreenArea (Rectangle< int > targetArea) const noexcept
 
Options withMinimumWidth (int minWidth) const noexcept
 
Options withMinimumNumColumns (int minNumColumns) const noexcept
 
Options withMaximumNumColumns (int maxNumColumns) const noexcept
 
Options withStandardItemHeight (int standardHeight) const noexcept
 
Options withItemThatMustBeVisible (int idOfItemToBeVisible) const noexcept
 
Options withParentComponent (Component *parentComponent) const noexcept
 
Options withPreferredPopupDirection (PopupDirection direction) const noexcept
 
ComponentgetParentComponent () const noexcept
 
ComponentgetTargetComponent () const noexcept
 
Rectangle< int > getTargetScreenArea () const noexcept
 
int getMinimumWidth () const noexcept
 
int getMaximumNumColumns () const noexcept
 
int getMinimumNumColumns () const noexcept
 
int getStandardItemHeight () const noexcept
 
int getItemThatMustBeVisible () const noexcept
 
PopupDirection getPreferredPopupDirection () const noexcept
 

Detailed Description

Class used to create a set of options to pass to the show() method.

You can chain together a series of calls to this class's methods to create a set of whatever options you want to specify. E.g.

Member Enumeration Documentation

◆ PopupDirection

Enumerator
upwards 
downwards 

Constructor & Destructor Documentation

◆ Options() [1/2]

PopupMenu::Options::Options ( )

◆ Options() [2/2]

PopupMenu::Options::Options ( const Options )
default

Member Function Documentation

◆ operator=()

Options& PopupMenu::Options::operator= ( const Options )
default

◆ withTargetComponent()

Options PopupMenu::Options::withTargetComponent ( Component targetComponent) const
noexcept

◆ withTargetScreenArea()

Options PopupMenu::Options::withTargetScreenArea ( Rectangle< int >  targetArea) const
noexcept

◆ withMinimumWidth()

Options PopupMenu::Options::withMinimumWidth ( int  minWidth) const
noexcept

◆ withMinimumNumColumns()

Options PopupMenu::Options::withMinimumNumColumns ( int  minNumColumns) const
noexcept

◆ withMaximumNumColumns()

Options PopupMenu::Options::withMaximumNumColumns ( int  maxNumColumns) const
noexcept

◆ withStandardItemHeight()

Options PopupMenu::Options::withStandardItemHeight ( int  standardHeight) const
noexcept

◆ withItemThatMustBeVisible()

Options PopupMenu::Options::withItemThatMustBeVisible ( int  idOfItemToBeVisible) const
noexcept

◆ withParentComponent()

Options PopupMenu::Options::withParentComponent ( Component parentComponent) const
noexcept

◆ withPreferredPopupDirection()

Options PopupMenu::Options::withPreferredPopupDirection ( PopupDirection  direction) const
noexcept

◆ getParentComponent()

Component* PopupMenu::Options::getParentComponent ( ) const
noexcept

◆ getTargetComponent()

Component* PopupMenu::Options::getTargetComponent ( ) const
noexcept

◆ getTargetScreenArea()

Rectangle<int> PopupMenu::Options::getTargetScreenArea ( ) const
noexcept

◆ getMinimumWidth()

int PopupMenu::Options::getMinimumWidth ( ) const
noexcept

◆ getMaximumNumColumns()

int PopupMenu::Options::getMaximumNumColumns ( ) const
noexcept

◆ getMinimumNumColumns()

int PopupMenu::Options::getMinimumNumColumns ( ) const
noexcept

◆ getStandardItemHeight()

int PopupMenu::Options::getStandardItemHeight ( ) const
noexcept

◆ getItemThatMustBeVisible()

int PopupMenu::Options::getItemThatMustBeVisible ( ) const
noexcept

◆ getPreferredPopupDirection()

PopupDirection PopupMenu::Options::getPreferredPopupDirection ( ) const
noexcept

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