iPlug2 - C++ Audio Plug-in Framework
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
IPopupMenu::Item Class Reference

A class to specify an item of a pop up menu. More...

#include <IGraphicsPopupMenu.h>

Public Types

enum  Flags {
  kNoFlags = 0 , kDisabled = 1 << 0 , kTitle = 1 << 1 , kChecked = 1 << 2 ,
  kSeparator = 1 << 3 , kDeletable = 1 << 4
}
 

Public Member Functions

 Item (const char *str, int flags=kNoFlags, int tag=-1)
 
 Item (const char *str, IPopupMenu *pSubMenu)
 
 Item (const Item &)=delete
 
void operator= (const Item &)=delete
 
void SetText (const char *str)
 
const char * GetText () const
 
bool GetEnabled () const
 
bool GetChecked () const
 
bool GetIsTitle () const
 
bool GetIsSeparator () const
 
bool GetIsDeletable () const
 
int GetTag () const
 
IPopupMenu * GetSubmenu () const
 
bool GetIsChoosable () const
 
void SetEnabled (bool state)
 
void SetChecked (bool state)
 
void SetDeletable (bool state)
 
void SetTitle (bool state)
 
void SetSubmenu (IPopupMenu *pSubmenu)
 

Protected Member Functions

void SetFlag (Flags flag, bool state)
 

Protected Attributes

WDL_String mText
 
std::unique_ptr< IPopupMenu > mSubmenu
 
int mFlags
 
int mTag = -1
 

Detailed Description

A class to specify an item of a pop up menu.

Definition at line 44 of file IGraphicsPopupMenu.h.

Member Enumeration Documentation

◆ Flags

enum IPopupMenu::Item::Flags

Definition at line 47 of file IGraphicsPopupMenu.h.

Constructor & Destructor Documentation

◆ Item() [1/2]

IPopupMenu::Item::Item ( const char *  str,
int  flags = kNoFlags,
int  tag = -1 
)
inline

Definition at line 57 of file IGraphicsPopupMenu.h.

◆ Item() [2/2]

IPopupMenu::Item::Item ( const char *  str,
IPopupMenu *  pSubMenu 
)
inline

Definition at line 64 of file IGraphicsPopupMenu.h.

◆ ~Item()

IPopupMenu::Item::~Item ( )
inline

Definition at line 74 of file IGraphicsPopupMenu.h.

Member Function Documentation

◆ GetChecked()

bool IPopupMenu::Item::GetChecked ( ) const
inline

Definition at line 82 of file IGraphicsPopupMenu.h.

◆ GetEnabled()

bool IPopupMenu::Item::GetEnabled ( ) const
inline

Definition at line 81 of file IGraphicsPopupMenu.h.

◆ GetIsChoosable()

bool IPopupMenu::Item::GetIsChoosable ( ) const
inline

Definition at line 88 of file IGraphicsPopupMenu.h.

◆ GetIsDeletable()

bool IPopupMenu::Item::GetIsDeletable ( ) const
inline

Definition at line 85 of file IGraphicsPopupMenu.h.

◆ GetIsSeparator()

bool IPopupMenu::Item::GetIsSeparator ( ) const
inline

Definition at line 84 of file IGraphicsPopupMenu.h.

◆ GetIsTitle()

bool IPopupMenu::Item::GetIsTitle ( ) const
inline

Definition at line 83 of file IGraphicsPopupMenu.h.

◆ GetSubmenu()

IPopupMenu * IPopupMenu::Item::GetSubmenu ( ) const
inline

Definition at line 87 of file IGraphicsPopupMenu.h.

◆ GetTag()

int IPopupMenu::Item::GetTag ( ) const
inline

Definition at line 86 of file IGraphicsPopupMenu.h.

◆ GetText()

const char * IPopupMenu::Item::GetText ( ) const
inline

Definition at line 79 of file IGraphicsPopupMenu.h.

◆ SetChecked()

void IPopupMenu::Item::SetChecked ( bool  state)
inline

Definition at line 99 of file IGraphicsPopupMenu.h.

◆ SetDeletable()

void IPopupMenu::Item::SetDeletable ( bool  state)
inline

Definition at line 100 of file IGraphicsPopupMenu.h.

◆ SetEnabled()

void IPopupMenu::Item::SetEnabled ( bool  state)
inline

Definition at line 98 of file IGraphicsPopupMenu.h.

◆ SetFlag()

void IPopupMenu::Item::SetFlag ( Flags  flag,
bool  state 
)
inlineprotected

Definition at line 105 of file IGraphicsPopupMenu.h.

◆ SetSubmenu()

void IPopupMenu::Item::SetSubmenu ( IPopupMenu *  pSubmenu)
inline

Definition at line 102 of file IGraphicsPopupMenu.h.

◆ SetText()

void IPopupMenu::Item::SetText ( const char *  str)
inline

Definition at line 78 of file IGraphicsPopupMenu.h.

◆ SetTitle()

void IPopupMenu::Item::SetTitle ( bool  state)
inline

Definition at line 101 of file IGraphicsPopupMenu.h.

Member Data Documentation

◆ mFlags

int IPopupMenu::Item::mFlags
protected

Definition at line 115 of file IGraphicsPopupMenu.h.

◆ mSubmenu

std::unique_ptr<IPopupMenu> IPopupMenu::Item::mSubmenu
protected

Definition at line 114 of file IGraphicsPopupMenu.h.

◆ mTag

int IPopupMenu::Item::mTag = -1
protected

Definition at line 116 of file IGraphicsPopupMenu.h.

◆ mText

WDL_String IPopupMenu::Item::mText
protected

Definition at line 113 of file IGraphicsPopupMenu.h.


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