ASPiK SDK
VSTGUI::CMenuItem Class Reference

a menu item More...

#include <coptionmenu.h>

Inheritance diagram for VSTGUI::CMenuItem:
VSTGUI::CBaseObject VSTGUI::ReferenceCounted< T > VSTGUI::IReference VSTGUI::CCommandMenuItem

Public Types

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

Public Member Functions

 CMenuItem (const UTF8String &title, const UTF8String &keycode="", int32_t keyModifiers=0, CBitmap *icon=nullptr, int32_t flags=kNoFlags)
 
 CMenuItem (const UTF8String &title, COptionMenu *submenu, CBitmap *icon=nullptr)
 
 CMenuItem (const UTF8String &title, int32_t tag)
 
 CMenuItem (const CMenuItem &item)
 
CMenuItem Methods
virtual void setTitle (const UTF8String &title)
 set title of menu item
 
virtual void setSubmenu (COptionMenu *submenu)
 set submenu of menu item
 
virtual void setKey (const UTF8String &keyCode, int32_t keyModifiers=0)
 set keycode and key modifiers of menu item
 
virtual void setVirtualKey (int32_t virtualKeyCode, int32_t keyModifiers=0)
 set virtual keycode and key modifiers of menu item
 
virtual void setEnabled (bool state=true)
 set menu item enabled state
 
virtual void setChecked (bool state=true)
 set menu item checked state
 
virtual void setIsTitle (bool state=true)
 set menu item title state
 
virtual void setIsSeparator (bool state=true)
 set menu item separator state
 
virtual void setIcon (CBitmap *icon)
 set menu item icon
 
virtual void setTag (int32_t tag)
 set menu item tag
 
bool isEnabled () const
 returns whether the item is enabled or not
 
bool isChecked () const
 returns whether the item is checked or not
 
bool isTitle () const
 returns whether the item is a title item or not
 
bool isSeparator () const
 returns whether the item is a separator or not
 
const UTF8StringgetTitle () const
 returns the title of the item
 
int32_t getKeyModifiers () const
 returns the key modifiers of the item
 
const UTF8StringgetKeycode () const
 returns the keycode of the item
 
int32_t getVirtualKeyCode () const
 returns the virtual keycode of the item
 
COptionMenugetSubmenu () const
 returns the submenu of the item
 
CBitmapgetIcon () const
 returns the icon of the item
 
int32_t getTag () const
 returns the tag of the item
 
- Public Member Functions inherited from VSTGUI::CBaseObject
 CBaseObject (const CBaseObject &o)
 
CBaseObjectoperator= (const CBaseObject &obj)
 
virtual CMessageResult notify (CBaseObject *sender, IdStringPtr message)
 
- Public Member Functions inherited from VSTGUI::ReferenceCounted< T >
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
void forget () override
 decrease refcount and delete object if refcount == 0
 
void remember () override
 increase refcount
 
virtual int32_t getNbReference () const
 get refcount
 
virtual void beforeDelete ()
 

Protected Attributes

UTF8String title
 
UTF8String keyCode
 
SharedPointer< COptionMenusubmenu
 
SharedPointer< CBitmapicon
 
int32_t flags {0}
 
int32_t keyModifiers {0}
 
int32_t virtualKeyCode {0}
 
int32_t tag {-1}
 

Detailed Description

a menu item

Defines an item of a VSTGUI::COptionMenu

Member Enumeration Documentation

◆ Flags

Enumerator
kDisabled 

item is gray and not selectable

kTitle 

item indicates a title and is not selectable

kChecked 

item has a checkmark

kSeparator 

item is a separator

Constructor & Destructor Documentation

◆ CMenuItem() [1/4]

VSTGUI::CMenuItem::CMenuItem ( const UTF8String inTitle,
const UTF8String inKeycode = "",
int32_t  inKeyModifiers = 0,
CBitmap inIcon = nullptr,
int32_t  inFlags = kNoFlags 
)

CMenuItem constructor.

Parameters
inTitletitle of item
inFlagsCMenuItem::Flags of item
inKeycodekeycode of item
inKeyModifierskeymodifiers of item
inIconicon of item

◆ CMenuItem() [2/4]

VSTGUI::CMenuItem::CMenuItem ( const UTF8String inTitle,
COptionMenu inSubmenu,
CBitmap inIcon = nullptr 
)

CMenuItem constructor.

Parameters
inTitletitle of item
inSubmenusubmenu of item
inIconicon of item

◆ CMenuItem() [3/4]

VSTGUI::CMenuItem::CMenuItem ( const UTF8String inTitle,
int32_t  inTag 
)

CMenuItem constructor.

Parameters
inTitletitle of item
inTagtag of item

◆ CMenuItem() [4/4]

VSTGUI::CMenuItem::CMenuItem ( const CMenuItem item)

CMenuItem copy constructor.

Parameters
itemitem to copy

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