This abstract base class is implemented by LookAndFeel classes to provide menu drawing functionality. More...

#include "juce_PopupMenu.h"

Inheritance diagram for juce::PopupMenu::LookAndFeelMethods:

Public Member Functions
virtual void	drawPopupMenuBackground (Graphics &, int width, int height)
	Fills the background of a popup menu component.

virtual void	drawPopupMenuBackgroundWithOptions (Graphics &, int width, int height, const Options &)=0
	Fills the background of a popup menu component.

virtual void	drawPopupMenuItem (Graphics &, const Rectangle< int > &area, bool isSeparator, bool isActive, bool isHighlighted, bool isTicked, bool hasSubMenu, const String &text, const String &shortcutKeyText, const Drawable icon, const Colour textColour)
	Draws one of the items in a popup menu.

virtual void	drawPopupMenuItemWithOptions (Graphics &, const Rectangle< int > &area, bool isHighlighted, const Item &item, const Options &)=0
	Draws one of the items in a popup menu.

virtual void	drawPopupMenuSectionHeader (Graphics &, const Rectangle< int > &, const String &)

virtual void	drawPopupMenuSectionHeaderWithOptions (Graphics &, const Rectangle< int > &area, const String &sectionName, const Options &)=0

virtual Font	getPopupMenuFont ()=0
	Returns the size and style of font to use in popup menus.

virtual void	drawPopupMenuUpDownArrow (Graphics &, int width, int height, bool isScrollUpArrow)

virtual void	drawPopupMenuUpDownArrowWithOptions (Graphics &, int width, int height, bool isScrollUpArrow, const Options &)=0

virtual void	getIdealPopupMenuItemSize (const String &text, bool isSeparator, int standardMenuItemHeight, int &idealWidth, int &idealHeight)
	Finds the best size for an item in a popup menu.

virtual void	getIdealPopupMenuItemSizeWithOptions (const String &text, bool isSeparator, int standardMenuItemHeight, int &idealWidth, int &idealHeight, const Options &)=0
	Finds the best size for an item in a popup menu.

virtual int	getMenuWindowFlags ()=0

virtual void	drawMenuBarBackground (Graphics &, int width, int height, bool isMouseOverBar, MenuBarComponent &)=0

virtual int	getDefaultMenuBarHeight ()=0

virtual int	getMenuBarItemWidth (MenuBarComponent &, int itemIndex, const String &itemText)=0

virtual Font	getMenuBarFont (MenuBarComponent &, int itemIndex, const String &itemText)=0

virtual void	drawMenuBarItem (Graphics &, int width, int height, int itemIndex, const String &itemText, bool isMouseOverItem, bool isMenuOpen, bool isMouseOverBar, MenuBarComponent &)=0

virtual Component *	getParentComponentForMenuOptions (const Options &options)=0

virtual void	preparePopupMenuWindow (Component &newWindow)=0

virtual bool	shouldPopupMenuScaleWithTargetComponent (const Options &options)=0
	Return true if you want your popup menus to scale with the target component's AffineTransform or scale factor.

virtual int	getPopupMenuBorderSize ()

virtual int	getPopupMenuBorderSizeWithOptions (const Options &)=0

virtual void	drawPopupMenuColumnSeparatorWithOptions (Graphics &g, const Rectangle< int > &bounds, const Options &)=0
	Implement this to draw some custom decoration between the columns of the popup menu.

virtual int	getPopupMenuColumnSeparatorWidthWithOptions (const Options &)=0
	Return the amount of space that should be left between popup menu columns.

Detailed Description

This abstract base class is implemented by LookAndFeel classes to provide menu drawing functionality.

Definition at line 933 of file juce_PopupMenu.h.

Member Function Documentation

◆ drawPopupMenuBackground()

void juce::PopupMenu::LookAndFeelMethods::drawPopupMenuBackground	(	Graphics &	,
		int	width,
		int	height
	)

virtual

Fills the background of a popup menu component.

Reimplemented in juce::LookAndFeel_V1, juce::LookAndFeel_V2, and juce::LookAndFeel_V3.

Definition at line 2380 of file juce_PopupMenu.cpp.

◆ drawPopupMenuBackgroundWithOptions()

virtual void juce::PopupMenu::LookAndFeelMethods::drawPopupMenuBackgroundWithOptions	(	Graphics &	,
		int	width,
		int	height,
		const Options &
	)

pure virtual

Fills the background of a popup menu component.

Implemented in juce::LookAndFeel_V2.

◆ drawPopupMenuColumnSeparatorWithOptions()

virtual void juce::PopupMenu::LookAndFeelMethods::drawPopupMenuColumnSeparatorWithOptions	(	Graphics &	g,
		const Rectangle< int > &	bounds,
		const Options &
	)

pure virtual

Implement this to draw some custom decoration between the columns of the popup menu.

getPopupMenuColumnSeparatorWidthWithOptions must return a positive value in order to display the separator.

Implemented in juce::LookAndFeel_V2.

◆ drawPopupMenuItem()

void juce::PopupMenu::LookAndFeelMethods::drawPopupMenuItem	(	Graphics &	,
		const Rectangle< int > &	area,
		bool	isSeparator,
		bool	isActive,
		bool	isHighlighted,
		bool	isTicked,
		bool	hasSubMenu,
		const String &	text,
		const String &	shortcutKeyText,
		const Drawable *	icon,
		const Colour *	textColour
	)

virtual

Draws one of the items in a popup menu.

Reimplemented in juce::LookAndFeel_V2, and juce::LookAndFeel_V4.

Definition at line 2382 of file juce_PopupMenu.cpp.

◆ drawPopupMenuItemWithOptions()

virtual void juce::PopupMenu::LookAndFeelMethods::drawPopupMenuItemWithOptions	(	Graphics &	,
		const Rectangle< int > &	area,
		bool	isHighlighted,
		const Item &	item,
		const Options &
	)

pure virtual

Draws one of the items in a popup menu.

Implemented in juce::LookAndFeel_V2.

◆ drawPopupMenuSectionHeader()

void juce::PopupMenu::LookAndFeelMethods::drawPopupMenuSectionHeader	(	Graphics &	,
		const Rectangle< int > &	,
		const String &
	)

virtual

Definition at line 2390 of file juce_PopupMenu.cpp.

◆ drawPopupMenuUpDownArrow()

void juce::PopupMenu::LookAndFeelMethods::drawPopupMenuUpDownArrow	(	Graphics &	,
		int	width,
		int	height,
		bool	isScrollUpArrow
	)

virtual

Definition at line 2393 of file juce_PopupMenu.cpp.

◆ getIdealPopupMenuItemSize()

void juce::PopupMenu::LookAndFeelMethods::getIdealPopupMenuItemSize	(	const String &	text,
		bool	isSeparator,
		int	standardMenuItemHeight,
		int &	idealWidth,
		int &	idealHeight
	)

virtual

Finds the best size for an item in a popup menu.

Reimplemented in juce::LookAndFeel_V2, and juce::LookAndFeel_V4.

Definition at line 2395 of file juce_PopupMenu.cpp.

◆ getIdealPopupMenuItemSizeWithOptions()

virtual void juce::PopupMenu::LookAndFeelMethods::getIdealPopupMenuItemSizeWithOptions	(	const String &	text,
		bool	isSeparator,
		int	standardMenuItemHeight,
		int &	idealWidth,
		int &	idealHeight,
		const Options &
	)

pure virtual

Finds the best size for an item in a popup menu.

Implemented in juce::LookAndFeel_V2.

◆ getPopupMenuBorderSize()

int juce::PopupMenu::LookAndFeelMethods::getPopupMenuBorderSize ( )

virtual

Definition at line 2397 of file juce_PopupMenu.cpp.

◆ getPopupMenuColumnSeparatorWidthWithOptions()

virtual int juce::PopupMenu::LookAndFeelMethods::getPopupMenuColumnSeparatorWidthWithOptions ( const Options & )

pure virtual

Return the amount of space that should be left between popup menu columns.

Implemented in juce::LookAndFeel_V2.

◆ getPopupMenuFont()

virtual Font juce::PopupMenu::LookAndFeelMethods::getPopupMenuFont ( )

pure virtual

Returns the size and style of font to use in popup menus.

Implemented in juce::LookAndFeel_V2.

◆ shouldPopupMenuScaleWithTargetComponent()

virtual bool juce::PopupMenu::LookAndFeelMethods::shouldPopupMenuScaleWithTargetComponent ( const Options & options )

pure virtual

Return true if you want your popup menus to scale with the target component's AffineTransform or scale factor.

Implemented in juce::LookAndFeel_V2.

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

juce_gui_basics/menus/juce_PopupMenu.h
juce_gui_basics/menus/juce_PopupMenu.cpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ drawPopupMenuBackground()

◆ drawPopupMenuBackgroundWithOptions()

◆ drawPopupMenuColumnSeparatorWithOptions()

◆ drawPopupMenuItem()

◆ drawPopupMenuItemWithOptions()

◆ drawPopupMenuSectionHeader()

◆ drawPopupMenuUpDownArrow()

◆ getIdealPopupMenuItemSize()

◆ getIdealPopupMenuItemSizeWithOptions()

◆ getPopupMenuBorderSize()

◆ getPopupMenuColumnSeparatorWidthWithOptions()

◆ getPopupMenuFont()

◆ shouldPopupMenuScaleWithTargetComponent()