Contents Up Previous Next

wxCommandInfo

Holds key binding information for a single command. TBD:: it has no relation with wxDocManager's wxCommand class. Should this be more explicit in it's name?

Derived from

wxObject

Data structures

enum wxKEY_MODIFIERS
{
    wxALT_DONW     = 0x01,
    wxCONTROL_DOWN = 0x02,
    wxSHIFT_DOWN   = 0x04
}
Members

wxCommandInfo::wxCommandInfo
wxCommandInfo::~wxCommandInfo
wxCommandInfo::AddKey
wxCommandInfo::AddSubcommand
wxCommandInfo::AssignInfoTo
wxCommandInfo::Clone
wxCommandInfo::FindCommandById
wxCommandInfo::GetBitmap
wxCommandInfo::GetHelpString
wxCommandInfo::GetId
wxCommandInfo::GetKeyCodes
wxCommandInfo::GetKeyCount
wxCommandInfo::GetKeyModifier
wxCommandInfo::GetKeyModifiers
wxCommandInfo::GetKeyStrokeString
wxCommandInfo::GetParent
wxCommandInfo::GetStrippedTitle
wxCommandInfo::GetSubcommands
wxCommandInfo::GetTitle
wxCommandInfo::GetUserData
wxCommandInfo::HasSubcommands
wxCommandInfo::IsCheckable
wxCommandInfo::IsChecked
wxCommandInfo::IsPritableChar
wxCommandInfo::IsSeparator
wxCommandInfo::KeyCodeToString
wxCommandInfo::KeyModifierToString
wxCommandInfo::KeyPresent
wxCommandInfo::ParseKeyStrokeString
wxCommandInfo::Prepare
wxCommandInfo::RemoveKey
wxCommandInfo::ResetUserData
wxCommandInfo::SetBitmap
wxCommandInfo::SetCheckable
wxCommandInfo::SetChecked
wxCommandInfo::SetCmdParent
wxCommandInfo::SetHelpString
wxCommandInfo::SetId
wxCommandInfo::SetTitle
wxCommandInfo::SetUserData
wxCommandInfo::StringToKeyCode
wxCommandInfo::StringToKeyModifier
wxCommandInfo::StripControlChars


wxCommandInfo::wxCommandInfo

wxCommandInfo(int id, const wxString& title, const wxString& helpString = wxEmptyString, const wxString& keyStroke = wxEmptyString, bool isCheckable = FALSE, bool isChecked = FALSE)

ctor

wxCommandInfo()


wxCommandInfo::~wxCommandInfo

~wxCommandInfo()


wxCommandInfo::AddKey

bool AddKey(int keyCode, int modifiers)

returns TRUE, if array's not overfilled


wxCommandInfo::AddSubcommand

void AddSubcommand(wxCommandInfo* pInfo)


wxCommandInfo::AssignInfoTo

void AssignInfoTo(wxCommandInfo* pOther)


wxCommandInfo::Clone

wxCommandInfo* Clone()

returns NULL for this class, but is overriden in wxCommandGroup


wxCommandInfo::FindCommandById

wxCommandInfo* FindCommandById(int id)


wxCommandInfo::GetBitmap

const wxBitmap& GetBitmap()


wxCommandInfo::GetHelpString

const wxString& GetHelpString()


wxCommandInfo::GetId

int GetId()


wxCommandInfo::GetKeyCodes

int* GetKeyCodes()


wxCommandInfo::GetKeyCount

size_t GetKeyCount()

of static wxCommandInfo objects is finished (becasue _gVKHash cannot be accessed during static inits)


wxCommandInfo::GetKeyModifier

int GetKeyModifier(wxKeyEvent& event)


wxCommandInfo::GetKeyModifiers

int* GetKeyModifiers()


wxCommandInfo::GetKeyStrokeString

wxString GetKeyStrokeString(wxCommandInfo& cmd, int keyIndex)

wxString GetKeyStrokeString(wxKeyEvent& event)


wxCommandInfo::GetParent

wxCommandInfo* GetParent()


wxCommandInfo::GetStrippedTitle

wxString GetStrippedTitle()


wxCommandInfo::GetSubcommands

wxCommandInfoListT* GetSubcommands()


wxCommandInfo::GetTitle

const wxString& GetTitle()


wxCommandInfo::GetUserData

wxObject* GetUserData()


wxCommandInfo::HasSubcommands

bool HasSubcommands()


wxCommandInfo::IsCheckable

bool IsCheckable()


wxCommandInfo::IsChecked

bool IsChecked()


wxCommandInfo::IsPritableChar

bool IsPritableChar(int c)


wxCommandInfo::IsSeparator

bool IsSeparator()


wxCommandInfo::KeyCodeToString

wxString KeyCodeToString(int keyCode)

utilities (static)


wxCommandInfo::KeyModifierToString

wxString KeyModifierToString(int keyModifier)


wxCommandInfo::KeyPresent

bool KeyPresent(int keyCode, int modifiers)


wxCommandInfo::ParseKeyStrokeString

bool ParseKeyStrokeString(const wxString& stroke, int* key, int* modifier)


wxCommandInfo::Prepare

void Prepare()

called by wxKeyBinder to call after initialization


wxCommandInfo::RemoveKey

bool RemoveKey(size_t keyNo)


wxCommandInfo::ResetUserData

void ResetUserData()


wxCommandInfo::SetBitmap

void SetBitmap(const wxBitmap& bmp)


wxCommandInfo::SetCheckable

void SetCheckable(bool checkable)


wxCommandInfo::SetChecked

void SetChecked(bool checked)


wxCommandInfo::SetCmdParent

void SetCmdParent(wxCommandInfo* pParent)


wxCommandInfo::SetHelpString

void SetHelpString(const wxString& helpString)


wxCommandInfo::SetId

void SetId(int id)


wxCommandInfo::SetTitle

void SetTitle(const wxString& title)


wxCommandInfo::SetUserData

void SetUserData(wxObject* pData)


wxCommandInfo::StringToKeyCode

int StringToKeyCode(const wxString& keyName)


wxCommandInfo::StringToKeyModifier

int StringToKeyModifier(const wxString& keyModifier)


wxCommandInfo::StripControlChars

wxString StripControlChars(const wxString& cmdTitle)