PopupMenu::Options Class Reference

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

#include <juce_PopupMenu.h>

Collaboration diagram for PopupMenu::Options:

Public Member Functions
	Options ()
int	getItemThatMustBeVisible () const noexcept
int	getMaximumNumColumns () const noexcept
int	getMinimumWidth () const noexcept
Component *	getParentComponent () const noexcept
int	getStandardItemHeight () const noexcept
Component *	getTargetComponent () const noexcept
Rectangle< int >	getTargetScreenArea () const noexcept
Options	withItemThatMustBeVisible (int idOfItemToBeVisible) const noexcept
Options	withMaximumNumColumns (int maxNumColumns) const noexcept
Options	withMinimumWidth (int minWidth) const noexcept
Options	withParentComponent (Component *parentComponent) const noexcept
Options	withStandardItemHeight (int standardHeight) const noexcept
Options	withTargetComponent (Component *targetComponent) const noexcept
Options	withTargetScreenArea (const Rectangle< int > &targetArea) const noexcept

Private Attributes
int	maxColumns
int	minWidth
Component *	parentComponent
int	standardHeight
Rectangle< int >	targetArea
Component *	targetComponent
int	visibleItemID

Friends
class	PopupMenu
class	PopupMenu::Window

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.

PopupMenu menu;
...
menu.showMenu (PopupMenu::Options().withMinimumWidth (100)
                                   .withMaximumNumColumns (3)
                                   .withTargetComponent (myComp));

Constructor & Destructor Documentation

Options()

PopupMenu::Options::Options

(

)

Member Function Documentation

getItemThatMustBeVisible()

int PopupMenu::Options::getItemThatMustBeVisible ( ) const

inlinenoexcept

getMaximumNumColumns()

int PopupMenu::Options::getMaximumNumColumns ( ) const

inlinenoexcept

getMinimumWidth()

int PopupMenu::Options::getMinimumWidth ( ) const

inlinenoexcept

getParentComponent()

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

inlinenoexcept

getStandardItemHeight()

int PopupMenu::Options::getStandardItemHeight ( ) const

inlinenoexcept

getTargetComponent()

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

inlinenoexcept

getTargetScreenArea()

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

inlinenoexcept

withItemThatMustBeVisible()

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

noexcept

withMaximumNumColumns()

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

noexcept

withMinimumWidth()

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

noexcept

withParentComponent()

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

noexcept

withStandardItemHeight()

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

noexcept

withTargetComponent()

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

noexcept

withTargetScreenArea()

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

noexcept

Friends And Related Function Documentation

PopupMenu

friend class PopupMenu

friend

PopupMenu::Window

friend class PopupMenu::Window

friend

Member Data Documentation

maxColumns

int PopupMenu::Options::maxColumns

private

minWidth

int PopupMenu::Options::minWidth

private

parentComponent

Component* PopupMenu::Options::parentComponent

private

standardHeight

int PopupMenu::Options::standardHeight

private

targetArea

Rectangle<int> PopupMenu::Options::targetArea

private

targetComponent

Component* PopupMenu::Options::targetComponent

private

visibleItemID

int PopupMenu::Options::visibleItemID

private

---

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

• juce_PopupMenu.h