AxTextMenuItem Class Reference
[Basic AxTk UI classes]
This menu item shows a text input dialog when activated.
More...
#include <ax/ax_menu_text.h>
Inheritance diagram for AxTextMenuItem:
Public Member Functions | |
| AxTextMenuItem (const AxTextMenuItem &item) | |
| AxTextMenuItem () | |
| AxTextMenuItem (const wxString &label, const wxString &description, const wxString &id, const wxString &caption, const wxString &message, const wxString &value, int style=0) | |
| bool | Create (const wxString &label, const wxString &description, const wxString &id, const wxString &caption, const wxString &message, const wxString &value, int style=0) |
| void | Init () |
| Member initialisation. | |
| void | Copy (const AxTextMenuItem &item) |
| AxMenuItem * | Clone () const |
| Override this function for derived classes. | |
| void | SetCaption (const wxString &caption) |
| Set caption. | |
| const wxString & | GetCaption () const |
| Get caption. | |
| void | SetMessage (const wxString &msg) |
| Set message. | |
| const wxString & | GetMessage () const |
| Get message. | |
| void | SetValue (const wxString &value) |
| Set value. | |
| const wxString & | GetValue () const |
| Get value. | |
| void | SendTextUpdate (const wxString &value) |
| wxString | CreateString (const wxString &spec, bool isLabel) |
Protected Attributes | |
| wxString | m_caption |
| wxString | m_message |
| wxString | m_value |
Detailed Description
This menu item shows a text input dialog when activated.label and description can both contain the VALUE% keyword, which will be substituted with the current value.
Set the style to axMENU_STYLE_MULTILINE_TEXT if you wish the input dialog to show a multiline text control.
When the value is changed, a wxEVT_COMMAND_TEXT_UPDATED event is generated.
Constructor & Destructor Documentation
| AxTextMenuItem::AxTextMenuItem | ( | const AxTextMenuItem & | item | ) | [inline] |
| AxTextMenuItem::AxTextMenuItem | ( | ) | [inline] |
| AxTextMenuItem::AxTextMenuItem | ( | const wxString & | label, | |
| const wxString & | description, | |||
| const wxString & | id, | |||
| const wxString & | caption, | |||
| const wxString & | message, | |||
| const wxString & | value, | |||
| int | style = 0 | |||
| ) |
Member Function Documentation
| AxMenuItem* AxTextMenuItem::Clone | ( | ) | const [inline, virtual] |
| void AxTextMenuItem::Copy | ( | const AxTextMenuItem & | item | ) | [inline] |
| bool AxTextMenuItem::Create | ( | const wxString & | label, | |
| const wxString & | description, | |||
| const wxString & | id, | |||
| const wxString & | caption, | |||
| const wxString & | message, | |||
| const wxString & | value, | |||
| int | style = 0 | |||
| ) |
| wxString AxTextMenuItem::CreateString | ( | const wxString & | spec, | |
| bool | isLabel | |||
| ) |
| const wxString& AxTextMenuItem::GetCaption | ( | ) | const [inline] |
Get caption.
| const wxString& AxTextMenuItem::GetMessage | ( | ) | const [inline] |
Get message.
| const wxString& AxTextMenuItem::GetValue | ( | ) | const [inline] |
Get value.
| void AxTextMenuItem::Init | ( | ) | [inline] |
| void AxTextMenuItem::SendTextUpdate | ( | const wxString & | value | ) |
| void AxTextMenuItem::SetCaption | ( | const wxString & | caption | ) | [inline] |
Set caption.
| void AxTextMenuItem::SetMessage | ( | const wxString & | msg | ) | [inline] |
Set message.
| void AxTextMenuItem::SetValue | ( | const wxString & | value | ) |
Set value.
Member Data Documentation
wxString AxTextMenuItem::m_caption [protected] |
wxString AxTextMenuItem::m_message [protected] |
wxString AxTextMenuItem::m_value [protected] |
The documentation for this class was generated from the following files:
- include/ax/ax_menu_text.h
- src/ax/ax_menu_text.cpp
