Add missing code tag before lots of wxEventTypes in the documentation. Although most of the documentation did this quite a few were missing.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@66611 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -33,7 +33,7 @@
|
|||||||
|
|
||||||
@beginEventEmissionTable{wxCommandEvent}
|
@beginEventEmissionTable{wxCommandEvent}
|
||||||
@event{EVT_BUTTON(id, func)}
|
@event{EVT_BUTTON(id, func)}
|
||||||
Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.
|
Process a @c wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
@library{wxcore}
|
@library{wxcore}
|
||||||
|
@@ -38,12 +38,12 @@
|
|||||||
|
|
||||||
@beginEventEmissionTable{wxCommandEvent}
|
@beginEventEmissionTable{wxCommandEvent}
|
||||||
@event{EVT_COMBOBOX(id, func)}
|
@event{EVT_COMBOBOX(id, func)}
|
||||||
Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
|
Process a @c wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
|
||||||
the list is selected.
|
the list is selected.
|
||||||
@event{EVT_TEXT(id, func)}
|
@event{EVT_TEXT(id, func)}
|
||||||
Process a wxEVT_COMMAND_TEXT_UPDATED event, when the combobox text changes.
|
Process a @c wxEVT_COMMAND_TEXT_UPDATED event, when the combobox text changes.
|
||||||
@event{EVT_TEXT_ENTER(id, func)}
|
@event{EVT_TEXT_ENTER(id, func)}
|
||||||
Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
|
Process a @c wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
|
||||||
the combobox.
|
the combobox.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
|
@@ -50,7 +50,7 @@
|
|||||||
|
|
||||||
@beginEventEmissionTable{wxCommandEvent}
|
@beginEventEmissionTable{wxCommandEvent}
|
||||||
@event{EVT_BUTTON(id, func)}
|
@event{EVT_BUTTON(id, func)}
|
||||||
Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.
|
Process a @c wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
|
|
||||||
|
@@ -41,7 +41,7 @@ enum wxCheckBoxState
|
|||||||
|
|
||||||
@beginEventEmissionTable{wxCommandEvent}
|
@beginEventEmissionTable{wxCommandEvent}
|
||||||
@event{EVT_CHECKBOX(id, func)}
|
@event{EVT_CHECKBOX(id, func)}
|
||||||
Process a wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox
|
Process a @c wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox
|
||||||
is clicked.
|
is clicked.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
@@ -148,7 +148,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
Sets the checkbox to the given state. This does not cause a
|
Sets the checkbox to the given state. This does not cause a
|
||||||
wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.
|
@c wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.
|
||||||
|
|
||||||
@param state
|
@param state
|
||||||
If @true, the check is on, otherwise it is off.
|
If @true, the check is on, otherwise it is off.
|
||||||
@@ -157,7 +157,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
Sets the checkbox to the given state. This does not cause a
|
Sets the checkbox to the given state. This does not cause a
|
||||||
wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.
|
@c wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.
|
||||||
|
|
||||||
Asserts when the checkbox is a 2-state checkbox and setting the state
|
Asserts when the checkbox is a 2-state checkbox and setting the state
|
||||||
to wxCHK_UNDETERMINED.
|
to wxCHK_UNDETERMINED.
|
||||||
|
@@ -17,7 +17,7 @@
|
|||||||
|
|
||||||
@beginEventEmissionTable{wxCommandEvent}
|
@beginEventEmissionTable{wxCommandEvent}
|
||||||
@event{EVT_CHECKLISTBOX(id, func)}
|
@event{EVT_CHECKLISTBOX(id, func)}
|
||||||
Process a wxEVT_COMMAND_CHECKLISTBOX_TOGGLED event, when an item in
|
Process a @c wxEVT_COMMAND_CHECKLISTBOX_TOGGLED event, when an item in
|
||||||
the check list box is checked or unchecked. wxCommandEvent::GetInt()
|
the check list box is checked or unchecked. wxCommandEvent::GetInt()
|
||||||
will contain the index of the item that was checked or unchecked.
|
will contain the index of the item that was checked or unchecked.
|
||||||
wxCommandEvent::IsChecked() is not valid! Use wxCheckListBox::IsChecked()
|
wxCommandEvent::IsChecked() is not valid! Use wxCheckListBox::IsChecked()
|
||||||
@@ -116,7 +116,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
Checks the given item. Note that calling this method does not result in
|
Checks the given item. Note that calling this method does not result in
|
||||||
a wxEVT_COMMAND_CHECKLISTBOX_TOGGLE event being emitted.
|
a @c wxEVT_COMMAND_CHECKLISTBOX_TOGGLE event being emitted.
|
||||||
|
|
||||||
@param item
|
@param item
|
||||||
Index of item to check.
|
Index of item to check.
|
||||||
|
@@ -20,7 +20,7 @@
|
|||||||
|
|
||||||
@beginEventEmissionTable{wxCommandEvent}
|
@beginEventEmissionTable{wxCommandEvent}
|
||||||
@event{EVT_CHOICE(id, func)}
|
@event{EVT_CHOICE(id, func)}
|
||||||
Process a wxEVT_COMMAND_CHOICE_SELECTED event, when an item on the
|
Process a @c wxEVT_COMMAND_CHOICE_SELECTED event, when an item on the
|
||||||
list is selected.
|
list is selected.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
|
@@ -304,7 +304,7 @@ struct wxComboCtrlFeatures
|
|||||||
@style{wxCB_SORT}
|
@style{wxCB_SORT}
|
||||||
Sorts the entries in the list alphabetically.
|
Sorts the entries in the list alphabetically.
|
||||||
@style{wxTE_PROCESS_ENTER}
|
@style{wxTE_PROCESS_ENTER}
|
||||||
The control will generate the event wxEVT_COMMAND_TEXT_ENTER
|
The control will generate the event @c wxEVT_COMMAND_TEXT_ENTER
|
||||||
(otherwise pressing Enter key is either processed internally by the
|
(otherwise pressing Enter key is either processed internally by the
|
||||||
control or used for navigation between dialog controls). Windows
|
control or used for navigation between dialog controls). Windows
|
||||||
only.
|
only.
|
||||||
@@ -319,15 +319,15 @@ struct wxComboCtrlFeatures
|
|||||||
|
|
||||||
@beginEventEmissionTable{wxCommandEvent}
|
@beginEventEmissionTable{wxCommandEvent}
|
||||||
@event{EVT_TEXT(id, func)}
|
@event{EVT_TEXT(id, func)}
|
||||||
Process a wxEVT_COMMAND_TEXT_UPDATED event, when the text changes.
|
Process a @c wxEVT_COMMAND_TEXT_UPDATED event, when the text changes.
|
||||||
@event{EVT_TEXT_ENTER(id, func)}
|
@event{EVT_TEXT_ENTER(id, func)}
|
||||||
Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
|
Process a @c wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
|
||||||
the combo control.
|
the combo control.
|
||||||
@event{EVT_COMBOBOX_DROPDOWN(id, func)}
|
@event{EVT_COMBOBOX_DROPDOWN(id, func)}
|
||||||
Process a wxEVT_COMMAND_COMBOBOX_DROPDOWN event, which is generated
|
Process a @c wxEVT_COMMAND_COMBOBOX_DROPDOWN event, which is generated
|
||||||
when the popup window is shown (drops down).
|
when the popup window is shown (drops down).
|
||||||
@event{EVT_COMBOBOX_CLOSEUP(id, func)}
|
@event{EVT_COMBOBOX_CLOSEUP(id, func)}
|
||||||
Process a wxEVT_COMMAND_COMBOBOX_CLOSEUP event, which is generated
|
Process a @c wxEVT_COMMAND_COMBOBOX_CLOSEUP event, which is generated
|
||||||
when the popup window of the combo control disappears (closes up).
|
when the popup window of the combo control disappears (closes up).
|
||||||
You should avoid adding or deleting items in this event.
|
You should avoid adding or deleting items in this event.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
@@ -412,7 +412,7 @@ public:
|
|||||||
Dismisses the popup window.
|
Dismisses the popup window.
|
||||||
|
|
||||||
Notice that calling this function will generate a
|
Notice that calling this function will generate a
|
||||||
wxEVT_COMMAND_COMBOBOX_CLOSEUP event.
|
@c wxEVT_COMMAND_COMBOBOX_CLOSEUP event.
|
||||||
|
|
||||||
@since 2.9.2
|
@since 2.9.2
|
||||||
*/
|
*/
|
||||||
@@ -554,7 +554,7 @@ public:
|
|||||||
|
|
||||||
@param generateEvent
|
@param generateEvent
|
||||||
Set this to @true in order to generate
|
Set this to @true in order to generate
|
||||||
wxEVT_COMMAND_COMBOBOX_CLOSEUP event.
|
@c wxEVT_COMMAND_COMBOBOX_CLOSEUP event.
|
||||||
|
|
||||||
@deprecated Use Dismiss() instead.
|
@deprecated Use Dismiss() instead.
|
||||||
*/
|
*/
|
||||||
@@ -597,7 +597,7 @@ public:
|
|||||||
Shows the popup portion of the combo control.
|
Shows the popup portion of the combo control.
|
||||||
|
|
||||||
Notice that calling this function will generate a
|
Notice that calling this function will generate a
|
||||||
wxEVT_COMMAND_COMBOBOX_DROPDOWN event.
|
@c wxEVT_COMMAND_COMBOBOX_DROPDOWN event.
|
||||||
|
|
||||||
@since 2.9.2
|
@since 2.9.2
|
||||||
*/
|
*/
|
||||||
@@ -813,7 +813,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
Same as SetValue(), but also sends wxCommandEvent of type
|
Same as SetValue(), but also sends wxCommandEvent of type
|
||||||
wxEVT_COMMAND_TEXT_UPDATED if @a withEvent is @true.
|
@c wxEVT_COMMAND_TEXT_UPDATED if @a withEvent is @true.
|
||||||
*/
|
*/
|
||||||
void SetValueWithEvent(const wxString& value, bool withEvent = true);
|
void SetValueWithEvent(const wxString& value, bool withEvent = true);
|
||||||
|
|
||||||
|
@@ -41,7 +41,7 @@
|
|||||||
@style{wxCB_SORT}
|
@style{wxCB_SORT}
|
||||||
Sorts the entries in the list alphabetically.
|
Sorts the entries in the list alphabetically.
|
||||||
@style{wxTE_PROCESS_ENTER}
|
@style{wxTE_PROCESS_ENTER}
|
||||||
The control will generate the event wxEVT_COMMAND_TEXT_ENTER
|
The control will generate the event @c wxEVT_COMMAND_TEXT_ENTER
|
||||||
(otherwise pressing Enter key is either processed internally by the
|
(otherwise pressing Enter key is either processed internally by the
|
||||||
control or used for navigation between dialog controls). Windows
|
control or used for navigation between dialog controls). Windows
|
||||||
only.
|
only.
|
||||||
@@ -49,26 +49,26 @@
|
|||||||
|
|
||||||
@beginEventEmissionTable{wxCommandEvent}
|
@beginEventEmissionTable{wxCommandEvent}
|
||||||
@event{EVT_COMBOBOX(id, func)}
|
@event{EVT_COMBOBOX(id, func)}
|
||||||
Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
|
Process a @c wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
|
||||||
the list is selected. Note that calling GetValue() returns the new
|
the list is selected. Note that calling GetValue() returns the new
|
||||||
value of selection.
|
value of selection.
|
||||||
@event{EVT_TEXT(id, func)}
|
@event{EVT_TEXT(id, func)}
|
||||||
Process a wxEVT_COMMAND_TEXT_UPDATED event, when the combobox text
|
Process a @c wxEVT_COMMAND_TEXT_UPDATED event, when the combobox text
|
||||||
changes.
|
changes.
|
||||||
@event{EVT_TEXT_ENTER(id, func)}
|
@event{EVT_TEXT_ENTER(id, func)}
|
||||||
Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
|
Process a @c wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
|
||||||
the combobox (notice that the combobox must have been created with
|
the combobox (notice that the combobox must have been created with
|
||||||
wxTE_PROCESS_ENTER style to receive this event).
|
wxTE_PROCESS_ENTER style to receive this event).
|
||||||
@event{EVT_COMBOBOX_DROPDOWN(id, func)}
|
@event{EVT_COMBOBOX_DROPDOWN(id, func)}
|
||||||
Process a wxEVT_COMMAND_COMBOBOX_DROPDOWN event, which is generated
|
Process a @c wxEVT_COMMAND_COMBOBOX_DROPDOWN event, which is generated
|
||||||
when the list box part of the combo box is shown (drops down).
|
when the list box part of the combo box is shown (drops down).
|
||||||
Notice that this event is currently only supported by wxMSW and
|
Notice that this event is currently only supported by wxMSW and
|
||||||
wxGTK with GTK+ 2.10 or later.
|
wxGTK with GTK+ 2.10 or later.
|
||||||
@event{EVT_COMBOBOX_CLOSEUP(id, func)}
|
@event{EVT_COMBOBOX_CLOSEUP(id, func)}
|
||||||
Process a wxEVT_COMMAND_COMBOBOX_CLOSEUP event, which is generated
|
Process a @c wxEVT_COMMAND_COMBOBOX_CLOSEUP event, which is generated
|
||||||
when the list box of the combo box disappears (closes up). This
|
when the list box of the combo box disappears (closes up). This
|
||||||
event is only generated for the same platforms as
|
event is only generated for the same platforms as
|
||||||
wxEVT_COMMAND_COMBOBOX_DROPDOWN above. Also note that only wxMSW
|
@c wxEVT_COMMAND_COMBOBOX_DROPDOWN above. Also note that only wxMSW
|
||||||
supports adding or deleting items in this event.
|
supports adding or deleting items in this event.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
@@ -237,7 +237,7 @@ public:
|
|||||||
/**
|
/**
|
||||||
Sets the text for the combobox text field.
|
Sets the text for the combobox text field.
|
||||||
|
|
||||||
Notice that this method will generate a wxEVT_COMMAND_TEXT_UPDATED
|
Notice that this method will generate a @c wxEVT_COMMAND_TEXT_UPDATED
|
||||||
event, use wxTextEntry::ChangeValue() if this is undesirable.
|
event, use wxTextEntry::ChangeValue() if this is undesirable.
|
||||||
|
|
||||||
@note For a combobox with @c wxCB_READONLY style the string must be in
|
@note For a combobox with @c wxCB_READONLY style the string must be in
|
||||||
@@ -255,7 +255,7 @@ public:
|
|||||||
Currently only implemented in wxMSW and wxGTK.
|
Currently only implemented in wxMSW and wxGTK.
|
||||||
|
|
||||||
Notice that calling this function will generate a
|
Notice that calling this function will generate a
|
||||||
wxEVT_COMMAND_COMBOBOX_DROPDOWN event.
|
@c wxEVT_COMMAND_COMBOBOX_DROPDOWN event.
|
||||||
|
|
||||||
@since 2.9.1
|
@since 2.9.1
|
||||||
*/
|
*/
|
||||||
@@ -267,7 +267,7 @@ public:
|
|||||||
Currently only implemented in wxMSW and wxGTK.
|
Currently only implemented in wxMSW and wxGTK.
|
||||||
|
|
||||||
Notice that calling this function will generate a
|
Notice that calling this function will generate a
|
||||||
wxEVT_COMMAND_COMBOBOX_CLOSEUP event.
|
@c wxEVT_COMMAND_COMBOBOX_CLOSEUP event.
|
||||||
|
|
||||||
@since 2.9.1
|
@since 2.9.1
|
||||||
*/
|
*/
|
||||||
|
@@ -163,7 +163,7 @@ public:
|
|||||||
|
|
||||||
This class changes the cursor to a query and puts the application into a
|
This class changes the cursor to a query and puts the application into a
|
||||||
'context-sensitive help mode'. When the user left-clicks on a window
|
'context-sensitive help mode'. When the user left-clicks on a window
|
||||||
within the specified window, a wxEVT_HELP event is sent to that control,
|
within the specified window, a @c wxEVT_HELP event is sent to that control,
|
||||||
and the application may respond to it by popping up some help.
|
and the application may respond to it by popping up some help.
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
@@ -232,7 +232,7 @@ public:
|
|||||||
|
|
||||||
Instances of this class may be used to add a question mark button that when
|
Instances of this class may be used to add a question mark button that when
|
||||||
pressed, puts the application into context-help mode. It does this by
|
pressed, puts the application into context-help mode. It does this by
|
||||||
creating a wxContextHelp object which itself generates a wxEVT_HELP event
|
creating a wxContextHelp object which itself generates a @c wxEVT_HELP event
|
||||||
when the user clicks on a window.
|
when the user clicks on a window.
|
||||||
|
|
||||||
On Windows, you may add a question-mark icon to a dialog by use of the
|
On Windows, you may add a question-mark icon to a dialog by use of the
|
||||||
|
@@ -276,7 +276,7 @@ public:
|
|||||||
/**
|
/**
|
||||||
Call this to inform the model that an item has changed.
|
Call this to inform the model that an item has changed.
|
||||||
|
|
||||||
This will eventually emit a wxEVT_DATAVIEW_ITEM_VALUE_CHANGED
|
This will eventually emit a @c wxEVT_DATAVIEW_ITEM_VALUE_CHANGED
|
||||||
event (in which the column fields will not be set) to the user.
|
event (in which the column fields will not be set) to the user.
|
||||||
*/
|
*/
|
||||||
bool ItemChanged(const wxDataViewItem& item);
|
bool ItemChanged(const wxDataViewItem& item);
|
||||||
@@ -296,7 +296,7 @@ public:
|
|||||||
/**
|
/**
|
||||||
Call this to inform the model that several items have changed.
|
Call this to inform the model that several items have changed.
|
||||||
|
|
||||||
This will eventually emit wxEVT_DATAVIEW_ITEM_VALUE_CHANGED
|
This will eventually emit @c wxEVT_DATAVIEW_ITEM_VALUE_CHANGED
|
||||||
events (in which the column fields will not be set) to the user.
|
events (in which the column fields will not be set) to the user.
|
||||||
*/
|
*/
|
||||||
bool ItemsChanged(const wxDataViewItemArray& items);
|
bool ItemsChanged(const wxDataViewItemArray& items);
|
||||||
@@ -337,7 +337,7 @@ public:
|
|||||||
This is also called from wxDataViewCtrl's internal editing code, e.g. when
|
This is also called from wxDataViewCtrl's internal editing code, e.g. when
|
||||||
editing a text field in the control.
|
editing a text field in the control.
|
||||||
|
|
||||||
This will eventually emit a wxEVT_DATAVIEW_ITEM_VALUE_CHANGED
|
This will eventually emit a @c wxEVT_DATAVIEW_ITEM_VALUE_CHANGED
|
||||||
event to the user.
|
event to the user.
|
||||||
*/
|
*/
|
||||||
virtual bool ValueChanged(const wxDataViewItem& item,
|
virtual bool ValueChanged(const wxDataViewItem& item,
|
||||||
@@ -2692,7 +2692,7 @@ public:
|
|||||||
void SetColumn(int col);
|
void SetColumn(int col);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
For wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only.
|
For @c wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only.
|
||||||
*/
|
*/
|
||||||
void SetDataViewColumn(wxDataViewColumn* col);
|
void SetDataViewColumn(wxDataViewColumn* col);
|
||||||
|
|
||||||
|
@@ -112,7 +112,7 @@ enum wxDialogLayoutAdaptationMode
|
|||||||
@style{wxDIALOG_EX_CONTEXTHELP}
|
@style{wxDIALOG_EX_CONTEXTHELP}
|
||||||
Under Windows, puts a query button on the caption. When pressed,
|
Under Windows, puts a query button on the caption. When pressed,
|
||||||
Windows will go into a context-sensitive help mode and wxWidgets
|
Windows will go into a context-sensitive help mode and wxWidgets
|
||||||
will send a wxEVT_HELP event if the user clicked on an application
|
will send a @c wxEVT_HELP event if the user clicked on an application
|
||||||
window. Note that this is an extended style and must be set by
|
window. Note that this is an extended style and must be set by
|
||||||
calling SetExtraStyle() before Create is called (two-step
|
calling SetExtraStyle() before Create is called (two-step
|
||||||
construction).
|
construction).
|
||||||
@@ -452,7 +452,7 @@ public:
|
|||||||
virtual bool IsModal() const;
|
virtual bool IsModal() const;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
The default handler for wxEVT_SYS_COLOUR_CHANGED.
|
The default handler for @c wxEVT_SYS_COLOUR_CHANGED.
|
||||||
|
|
||||||
@param event
|
@param event
|
||||||
The colour change event.
|
The colour change event.
|
||||||
|
@@ -93,7 +93,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
Enable automatic checks for the connection status and sending of
|
Enable automatic checks for the connection status and sending of
|
||||||
wxEVT_DIALUP_CONNECTED/wxEVT_DIALUP_DISCONNECTED events. The interval
|
@c wxEVT_DIALUP_CONNECTED/wxEVT_DIALUP_DISCONNECTED events. The interval
|
||||||
parameter is only for Unix where we do the check manually and specifies
|
parameter is only for Unix where we do the check manually and specifies
|
||||||
how often should we repeat the check (each minute by default). Under
|
how often should we repeat the check (each minute by default). Under
|
||||||
Windows, the notification about the change of connection status is sent
|
Windows, the notification about the change of connection status is sent
|
||||||
|
@@ -110,8 +110,8 @@ public:
|
|||||||
The identifier of the object (window, timer, ...) which generated
|
The identifier of the object (window, timer, ...) which generated
|
||||||
this event.
|
this event.
|
||||||
@param eventType
|
@param eventType
|
||||||
The unique type of event, e.g. wxEVT_PAINT, wxEVT_SIZE or
|
The unique type of event, e.g. @c wxEVT_PAINT, @c wxEVT_SIZE or
|
||||||
wxEVT_COMMAND_BUTTON_CLICKED.
|
@c wxEVT_COMMAND_BUTTON_CLICKED.
|
||||||
*/
|
*/
|
||||||
wxEvent(int id = 0, wxEventType eventType = wxEVT_NULL);
|
wxEvent(int id = 0, wxEventType eventType = wxEVT_NULL);
|
||||||
|
|
||||||
@@ -1573,22 +1573,22 @@ public:
|
|||||||
@event{EVT_SCROLLWIN(func)}
|
@event{EVT_SCROLLWIN(func)}
|
||||||
Process all scroll events.
|
Process all scroll events.
|
||||||
@event{EVT_SCROLLWIN_TOP(func)}
|
@event{EVT_SCROLLWIN_TOP(func)}
|
||||||
Process wxEVT_SCROLLWIN_TOP scroll-to-top events.
|
Process @c wxEVT_SCROLLWIN_TOP scroll-to-top events.
|
||||||
@event{EVT_SCROLLWIN_BOTTOM(func)}
|
@event{EVT_SCROLLWIN_BOTTOM(func)}
|
||||||
Process wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.
|
Process @c wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.
|
||||||
@event{EVT_SCROLLWIN_LINEUP(func)}
|
@event{EVT_SCROLLWIN_LINEUP(func)}
|
||||||
Process wxEVT_SCROLLWIN_LINEUP line up events.
|
Process @c wxEVT_SCROLLWIN_LINEUP line up events.
|
||||||
@event{EVT_SCROLLWIN_LINEDOWN(func)}
|
@event{EVT_SCROLLWIN_LINEDOWN(func)}
|
||||||
Process wxEVT_SCROLLWIN_LINEDOWN line down events.
|
Process @c wxEVT_SCROLLWIN_LINEDOWN line down events.
|
||||||
@event{EVT_SCROLLWIN_PAGEUP(func)}
|
@event{EVT_SCROLLWIN_PAGEUP(func)}
|
||||||
Process wxEVT_SCROLLWIN_PAGEUP page up events.
|
Process @c wxEVT_SCROLLWIN_PAGEUP page up events.
|
||||||
@event{EVT_SCROLLWIN_PAGEDOWN(func)}
|
@event{EVT_SCROLLWIN_PAGEDOWN(func)}
|
||||||
Process wxEVT_SCROLLWIN_PAGEDOWN page down events.
|
Process @c wxEVT_SCROLLWIN_PAGEDOWN page down events.
|
||||||
@event{EVT_SCROLLWIN_THUMBTRACK(func)}
|
@event{EVT_SCROLLWIN_THUMBTRACK(func)}
|
||||||
Process wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events
|
Process @c wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events
|
||||||
(frequent events sent as the user drags the thumbtrack).
|
(frequent events sent as the user drags the thumbtrack).
|
||||||
@event{EVT_SCROLLWIN_THUMBRELEASE(func)}
|
@event{EVT_SCROLLWIN_THUMBRELEASE(func)}
|
||||||
Process wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.
|
Process @c wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
|
|
||||||
@@ -2027,8 +2027,8 @@ public:
|
|||||||
wxTextCtrl but other windows can generate these events as well) when its
|
wxTextCtrl but other windows can generate these events as well) when its
|
||||||
content gets copied or cut to, or pasted from the clipboard.
|
content gets copied or cut to, or pasted from the clipboard.
|
||||||
|
|
||||||
There are three types of corresponding events wxEVT_COMMAND_TEXT_COPY,
|
There are three types of corresponding events @c wxEVT_COMMAND_TEXT_COPY,
|
||||||
wxEVT_COMMAND_TEXT_CUT and wxEVT_COMMAND_TEXT_PASTE.
|
@c wxEVT_COMMAND_TEXT_CUT and @c wxEVT_COMMAND_TEXT_PASTE.
|
||||||
|
|
||||||
If any of these events is processed (without being skipped) by an event
|
If any of these events is processed (without being skipped) by an event
|
||||||
handler, the corresponding operation doesn't take place which allows to
|
handler, the corresponding operation doesn't take place which allows to
|
||||||
@@ -2174,25 +2174,25 @@ public:
|
|||||||
/**
|
/**
|
||||||
Constructor. Valid event types are:
|
Constructor. Valid event types are:
|
||||||
|
|
||||||
@li wxEVT_ENTER_WINDOW
|
@li @c wxEVT_ENTER_WINDOW
|
||||||
@li wxEVT_LEAVE_WINDOW
|
@li @c wxEVT_LEAVE_WINDOW
|
||||||
@li wxEVT_LEFT_DOWN
|
@li @c wxEVT_LEFT_DOWN
|
||||||
@li wxEVT_LEFT_UP
|
@li @c wxEVT_LEFT_UP
|
||||||
@li wxEVT_LEFT_DCLICK
|
@li @c wxEVT_LEFT_DCLICK
|
||||||
@li wxEVT_MIDDLE_DOWN
|
@li @c wxEVT_MIDDLE_DOWN
|
||||||
@li wxEVT_MIDDLE_UP
|
@li @c wxEVT_MIDDLE_UP
|
||||||
@li wxEVT_MIDDLE_DCLICK
|
@li @c wxEVT_MIDDLE_DCLICK
|
||||||
@li wxEVT_RIGHT_DOWN
|
@li @c wxEVT_RIGHT_DOWN
|
||||||
@li wxEVT_RIGHT_UP
|
@li @c wxEVT_RIGHT_UP
|
||||||
@li wxEVT_RIGHT_DCLICK
|
@li @c wxEVT_RIGHT_DCLICK
|
||||||
@li wxEVT_MOUSE_AUX1_DOWN
|
@li @c wxEVT_MOUSE_AUX1_DOWN
|
||||||
@li wxEVT_MOUSE_AUX1_UP
|
@li @c wxEVT_MOUSE_AUX1_UP
|
||||||
@li wxEVT_MOUSE_AUX1_DCLICK
|
@li @c wxEVT_MOUSE_AUX1_DCLICK
|
||||||
@li wxEVT_MOUSE_AUX2_DOWN
|
@li @c wxEVT_MOUSE_AUX2_DOWN
|
||||||
@li wxEVT_MOUSE_AUX2_UP
|
@li @c wxEVT_MOUSE_AUX2_UP
|
||||||
@li wxEVT_MOUSE_AUX2_DCLICK
|
@li @c wxEVT_MOUSE_AUX2_DCLICK
|
||||||
@li wxEVT_MOTION
|
@li @c wxEVT_MOTION
|
||||||
@li wxEVT_MOUSEWHEEL
|
@li @c wxEVT_MOUSEWHEEL
|
||||||
*/
|
*/
|
||||||
wxMouseEvent(wxEventType mouseEventType = wxEVT_NULL);
|
wxMouseEvent(wxEventType mouseEventType = wxEVT_NULL);
|
||||||
|
|
||||||
@@ -2673,7 +2673,7 @@ public:
|
|||||||
to wxApp only, and only on Windows SmartPhone and PocketPC.
|
to wxApp only, and only on Windows SmartPhone and PocketPC.
|
||||||
It is generated when the system is low on memory; the application should free
|
It is generated when the system is low on memory; the application should free
|
||||||
up as much memory as possible, and restore full working state when it receives
|
up as much memory as possible, and restore full working state when it receives
|
||||||
a wxEVT_ACTIVATE or wxEVT_ACTIVATE_APP event.
|
a @c wxEVT_ACTIVATE or @c wxEVT_ACTIVATE_APP event.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
@library{wxcore}
|
@library{wxcore}
|
||||||
@@ -3202,45 +3202,45 @@ public:
|
|||||||
@event{EVT_SCROLL(func)}
|
@event{EVT_SCROLL(func)}
|
||||||
Process all scroll events.
|
Process all scroll events.
|
||||||
@event{EVT_SCROLL_TOP(func)}
|
@event{EVT_SCROLL_TOP(func)}
|
||||||
Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
|
Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
|
||||||
@event{EVT_SCROLL_BOTTOM(func)}
|
@event{EVT_SCROLL_BOTTOM(func)}
|
||||||
Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
|
Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
|
||||||
@event{EVT_SCROLL_LINEUP(func)}
|
@event{EVT_SCROLL_LINEUP(func)}
|
||||||
Process wxEVT_SCROLL_LINEUP line up events.
|
Process @c wxEVT_SCROLL_LINEUP line up events.
|
||||||
@event{EVT_SCROLL_LINEDOWN(func)}
|
@event{EVT_SCROLL_LINEDOWN(func)}
|
||||||
Process wxEVT_SCROLL_LINEDOWN line down events.
|
Process @c wxEVT_SCROLL_LINEDOWN line down events.
|
||||||
@event{EVT_SCROLL_PAGEUP(func)}
|
@event{EVT_SCROLL_PAGEUP(func)}
|
||||||
Process wxEVT_SCROLL_PAGEUP page up events.
|
Process @c wxEVT_SCROLL_PAGEUP page up events.
|
||||||
@event{EVT_SCROLL_PAGEDOWN(func)}
|
@event{EVT_SCROLL_PAGEDOWN(func)}
|
||||||
Process wxEVT_SCROLL_PAGEDOWN page down events.
|
Process @c wxEVT_SCROLL_PAGEDOWN page down events.
|
||||||
@event{EVT_SCROLL_THUMBTRACK(func)}
|
@event{EVT_SCROLL_THUMBTRACK(func)}
|
||||||
Process wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent as the
|
Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent as the
|
||||||
user drags the thumbtrack).
|
user drags the thumbtrack).
|
||||||
@event{EVT_SCROLL_THUMBRELEASE(func)}
|
@event{EVT_SCROLL_THUMBRELEASE(func)}
|
||||||
Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
|
Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
|
||||||
@event{EVT_SCROLL_CHANGED(func)}
|
@event{EVT_SCROLL_CHANGED(func)}
|
||||||
Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
|
Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
|
||||||
@event{EVT_COMMAND_SCROLL(id, func)}
|
@event{EVT_COMMAND_SCROLL(id, func)}
|
||||||
Process all scroll events.
|
Process all scroll events.
|
||||||
@event{EVT_COMMAND_SCROLL_TOP(id, func)}
|
@event{EVT_COMMAND_SCROLL_TOP(id, func)}
|
||||||
Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
|
Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
|
||||||
@event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
|
@event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
|
||||||
Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
|
Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
|
||||||
@event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
|
@event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
|
||||||
Process wxEVT_SCROLL_LINEUP line up events.
|
Process @c wxEVT_SCROLL_LINEUP line up events.
|
||||||
@event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
|
@event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
|
||||||
Process wxEVT_SCROLL_LINEDOWN line down events.
|
Process @c wxEVT_SCROLL_LINEDOWN line down events.
|
||||||
@event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
|
@event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
|
||||||
Process wxEVT_SCROLL_PAGEUP page up events.
|
Process @c wxEVT_SCROLL_PAGEUP page up events.
|
||||||
@event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
|
@event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
|
||||||
Process wxEVT_SCROLL_PAGEDOWN page down events.
|
Process @c wxEVT_SCROLL_PAGEDOWN page down events.
|
||||||
@event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
|
@event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
|
||||||
Process wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent
|
Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent
|
||||||
as the user drags the thumbtrack).
|
as the user drags the thumbtrack).
|
||||||
@event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
|
@event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
|
||||||
Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
|
Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
|
||||||
@event{EVT_COMMAND_SCROLL_CHANGED(func)}
|
@event{EVT_COMMAND_SCROLL_CHANGED(func)}
|
||||||
Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
|
Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
@library{wxcore}
|
@library{wxcore}
|
||||||
|
@@ -103,7 +103,7 @@
|
|||||||
@style{wxFRAME_EX_CONTEXTHELP}
|
@style{wxFRAME_EX_CONTEXTHELP}
|
||||||
Under Windows, puts a query button on the caption. When pressed,
|
Under Windows, puts a query button on the caption. When pressed,
|
||||||
Windows will go into a context-sensitive help mode and wxWidgets
|
Windows will go into a context-sensitive help mode and wxWidgets
|
||||||
will send a wxEVT_HELP event if the user clicked on an application
|
will send a @c wxEVT_HELP event if the user clicked on an application
|
||||||
window. Note that this is an extended style and must be set by
|
window. Note that this is an extended style and must be set by
|
||||||
calling SetExtraStyle before Create is called (two-step
|
calling SetExtraStyle before Create is called (two-step
|
||||||
construction). You cannot use this style together with
|
construction). You cannot use this style together with
|
||||||
|
@@ -182,10 +182,10 @@ protected:
|
|||||||
|
|
||||||
@beginEventEmissionTable
|
@beginEventEmissionTable
|
||||||
@event{EVT_LISTBOX(id, func)}
|
@event{EVT_LISTBOX(id, func)}
|
||||||
Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the list
|
Process a @c wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the list
|
||||||
is selected. See wxCommandEvent.
|
is selected. See wxCommandEvent.
|
||||||
@event{EVT_LISTBOX_DCLICK(id, func)}
|
@event{EVT_LISTBOX_DCLICK(id, func)}
|
||||||
Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the listbox is
|
Process a @c wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the listbox is
|
||||||
double-clicked. See wxCommandEvent.
|
double-clicked. See wxCommandEvent.
|
||||||
@event{EVT_HTML_CELL_CLICKED(id, func)}
|
@event{EVT_HTML_CELL_CLICKED(id, func)}
|
||||||
A wxHtmlCell was clicked. See wxHtmlCellEvent.
|
A wxHtmlCell was clicked. See wxHtmlCellEvent.
|
||||||
|
@@ -92,10 +92,10 @@ enum wxLayoutAlignment
|
|||||||
|
|
||||||
@beginEventEmissionTable{wxQueryLayoutInfoEvent,wxCalculateLayoutEvent}
|
@beginEventEmissionTable{wxQueryLayoutInfoEvent,wxCalculateLayoutEvent}
|
||||||
@event{EVT_QUERY_LAYOUT_INFO(func)}
|
@event{EVT_QUERY_LAYOUT_INFO(func)}
|
||||||
Process a wxEVT_QUERY_LAYOUT_INFO event, to get size, orientation and
|
Process a @c wxEVT_QUERY_LAYOUT_INFO event, to get size, orientation and
|
||||||
alignment from a window. See wxQueryLayoutInfoEvent.
|
alignment from a window. See wxQueryLayoutInfoEvent.
|
||||||
@event{EVT_CALCULATE_LAYOUT(func)}
|
@event{EVT_CALCULATE_LAYOUT(func)}
|
||||||
Process a wxEVT_CALCULATE_LAYOUT event, which asks the window to take a
|
Process a @c wxEVT_CALCULATE_LAYOUT event, which asks the window to take a
|
||||||
'bite' out of a rectangle provided by the algorithm. See wxCalculateLayoutEvent.
|
'bite' out of a rectangle provided by the algorithm. See wxCalculateLayoutEvent.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
@@ -294,7 +294,7 @@ public:
|
|||||||
|
|
||||||
@beginEventTable{wxQueryLayoutInfoEvent}
|
@beginEventTable{wxQueryLayoutInfoEvent}
|
||||||
@event{EVT_QUERY_LAYOUT_INFO(func)}
|
@event{EVT_QUERY_LAYOUT_INFO(func)}
|
||||||
Process a wxEVT_QUERY_LAYOUT_INFO event, to get size, orientation and alignment
|
Process a @c wxEVT_QUERY_LAYOUT_INFO event, to get size, orientation and alignment
|
||||||
from a window.
|
from a window.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
@@ -381,7 +381,7 @@ public:
|
|||||||
|
|
||||||
@beginEventTable{wxCalculateLayoutEvent}
|
@beginEventTable{wxCalculateLayoutEvent}
|
||||||
@event{EVT_CALCULATE_LAYOUT(func)}
|
@event{EVT_CALCULATE_LAYOUT(func)}
|
||||||
Process a wxEVT_CALCULATE_LAYOUT event, which asks the window to take a
|
Process a @c wxEVT_CALCULATE_LAYOUT event, which asks the window to take a
|
||||||
'bite' out of a rectangle provided by the algorithm.
|
'bite' out of a rectangle provided by the algorithm.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
|
@@ -51,10 +51,10 @@
|
|||||||
|
|
||||||
@beginEventEmissionTable{wxCommandEvent}
|
@beginEventEmissionTable{wxCommandEvent}
|
||||||
@event{EVT_LISTBOX(id, func)}
|
@event{EVT_LISTBOX(id, func)}
|
||||||
Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the
|
Process a @c wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the
|
||||||
list is selected or the selection changes.
|
list is selected or the selection changes.
|
||||||
@event{EVT_LISTBOX_DCLICK(id, func)}
|
@event{EVT_LISTBOX_DCLICK(id, func)}
|
||||||
Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the listbox
|
Process a @c wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the listbox
|
||||||
is double-clicked.
|
is double-clicked.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
|
@@ -533,7 +533,7 @@ public:
|
|||||||
Pull-right submenu.
|
Pull-right submenu.
|
||||||
@param helpString
|
@param helpString
|
||||||
An optional help string associated with the item.
|
An optional help string associated with the item.
|
||||||
By default, the handler for the wxEVT_MENU_HIGHLIGHT event displays
|
By default, the handler for the @c wxEVT_MENU_HIGHLIGHT event displays
|
||||||
this string in the status line.
|
this string in the status line.
|
||||||
|
|
||||||
@see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
|
@see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
|
||||||
|
@@ -85,7 +85,7 @@ public:
|
|||||||
is a platform-specific class).
|
is a platform-specific class).
|
||||||
|
|
||||||
Note that the HWND that the class contains is the actual HWND of the ActiveX
|
Note that the HWND that the class contains is the actual HWND of the ActiveX
|
||||||
control so using dynamic events and connecting to wxEVT_SIZE, for example,
|
control so using dynamic events and connecting to @c wxEVT_SIZE, for example,
|
||||||
will receive the actual size message sent to the control.
|
will receive the actual size message sent to the control.
|
||||||
|
|
||||||
It is somewhat similar to the ATL class CAxWindow in operation.
|
It is somewhat similar to the ATL class CAxWindow in operation.
|
||||||
|
@@ -108,7 +108,7 @@ public:
|
|||||||
virtual bool Layout();
|
virtual bool Layout();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
The default handler for wxEVT_SYS_COLOUR_CHANGED.
|
The default handler for @c wxEVT_SYS_COLOUR_CHANGED.
|
||||||
|
|
||||||
@param event
|
@param event
|
||||||
The colour change event.
|
The colour change event.
|
||||||
|
@@ -94,7 +94,7 @@ public:
|
|||||||
(see wxPGProperty::OnEvent() for more information).
|
(see wxPGProperty::OnEvent() for more information).
|
||||||
|
|
||||||
@remarks wxPropertyGrid will automatically unfocus the editor when
|
@remarks wxPropertyGrid will automatically unfocus the editor when
|
||||||
wxEVT_COMMAND_TEXT_ENTER is received and when it results in
|
@c wxEVT_COMMAND_TEXT_ENTER is received and when it results in
|
||||||
property value being modified. This happens regardless of
|
property value being modified. This happens regardless of
|
||||||
editor type (ie. behavior is same for any wxTextCtrl and
|
editor type (ie. behavior is same for any wxTextCtrl and
|
||||||
wxComboBox based editor).
|
wxComboBox based editor).
|
||||||
|
@@ -862,7 +862,7 @@ public:
|
|||||||
usually processes most events. Some, such as button press events of
|
usually processes most events. Some, such as button press events of
|
||||||
TextCtrlAndButton class, can be handled here. Also, if custom handling
|
TextCtrlAndButton class, can be handled here. Also, if custom handling
|
||||||
for regular events is desired, then that can also be done (for example,
|
for regular events is desired, then that can also be done (for example,
|
||||||
wxSystemColourProperty custom handles wxEVT_COMMAND_CHOICE_SELECTED
|
wxSystemColourProperty custom handles @c wxEVT_COMMAND_CHOICE_SELECTED
|
||||||
to display colour picker dialog when 'custom' selection is made).
|
to display colour picker dialog when 'custom' selection is made).
|
||||||
|
|
||||||
If the event causes value to be changed, SetValueInEvent() should be called
|
If the event causes value to be changed, SetValueInEvent() should be called
|
||||||
|
@@ -401,53 +401,53 @@ typedef int (*wxPGSortCallback)(wxPropertyGrid* propGrid,
|
|||||||
|
|
||||||
@beginEventEmissionTable{wxPropertyGridEvent}
|
@beginEventEmissionTable{wxPropertyGridEvent}
|
||||||
@event{EVT_PG_SELECTED (id, func)}
|
@event{EVT_PG_SELECTED (id, func)}
|
||||||
Respond to wxEVT_PG_SELECTED event, generated when a property selection
|
Respond to @c wxEVT_PG_SELECTED event, generated when a property selection
|
||||||
has been changed, either by user action or by indirect program
|
has been changed, either by user action or by indirect program
|
||||||
function. For instance, collapsing a parent property programmatically
|
function. For instance, collapsing a parent property programmatically
|
||||||
causes any selected child property to become unselected, and may
|
causes any selected child property to become unselected, and may
|
||||||
therefore cause this event to be generated.
|
therefore cause this event to be generated.
|
||||||
@event{EVT_PG_CHANGED(id, func)}
|
@event{EVT_PG_CHANGED(id, func)}
|
||||||
Respond to wxEVT_PG_CHANGED event, generated when property value
|
Respond to @c wxEVT_PG_CHANGED event, generated when property value
|
||||||
has been changed by the user.
|
has been changed by the user.
|
||||||
@event{EVT_PG_CHANGING(id, func)}
|
@event{EVT_PG_CHANGING(id, func)}
|
||||||
Respond to wxEVT_PG_CHANGING event, generated when property value
|
Respond to @c wxEVT_PG_CHANGING event, generated when property value
|
||||||
is about to be changed by user. Use wxPropertyGridEvent::GetValue()
|
is about to be changed by user. Use wxPropertyGridEvent::GetValue()
|
||||||
to take a peek at the pending value, and wxPropertyGridEvent::Veto()
|
to take a peek at the pending value, and wxPropertyGridEvent::Veto()
|
||||||
to prevent change from taking place, if necessary.
|
to prevent change from taking place, if necessary.
|
||||||
@event{EVT_PG_HIGHLIGHTED(id, func)}
|
@event{EVT_PG_HIGHLIGHTED(id, func)}
|
||||||
Respond to wxEVT_PG_HIGHLIGHTED event, which occurs when mouse
|
Respond to @c wxEVT_PG_HIGHLIGHTED event, which occurs when mouse
|
||||||
moves over a property. Event's property is NULL if hovered area does
|
moves over a property. Event's property is NULL if hovered area does
|
||||||
not belong to any property.
|
not belong to any property.
|
||||||
@event{EVT_PG_RIGHT_CLICK(id, func)}
|
@event{EVT_PG_RIGHT_CLICK(id, func)}
|
||||||
Respond to wxEVT_PG_RIGHT_CLICK event, which occurs when property is
|
Respond to @c wxEVT_PG_RIGHT_CLICK event, which occurs when property is
|
||||||
clicked on with right mouse button.
|
clicked on with right mouse button.
|
||||||
@event{EVT_PG_DOUBLE_CLICK(id, func)}
|
@event{EVT_PG_DOUBLE_CLICK(id, func)}
|
||||||
Respond to wxEVT_PG_DOUBLE_CLICK event, which occurs when property is
|
Respond to @c wxEVT_PG_DOUBLE_CLICK event, which occurs when property is
|
||||||
double-clicked on with left mouse button.
|
double-clicked on with left mouse button.
|
||||||
@event{EVT_PG_ITEM_COLLAPSED(id, func)}
|
@event{EVT_PG_ITEM_COLLAPSED(id, func)}
|
||||||
Respond to wxEVT_PG_ITEM_COLLAPSED event, generated when user collapses
|
Respond to @c wxEVT_PG_ITEM_COLLAPSED event, generated when user collapses
|
||||||
a property or category.
|
a property or category.
|
||||||
@event{EVT_PG_ITEM_EXPANDED(id, func)}
|
@event{EVT_PG_ITEM_EXPANDED(id, func)}
|
||||||
Respond to wxEVT_PG_ITEM_EXPANDED event, generated when user expands
|
Respond to @c wxEVT_PG_ITEM_EXPANDED event, generated when user expands
|
||||||
a property or category.
|
a property or category.
|
||||||
@event{EVT_PG_LABEL_EDIT_BEGIN(id, func)}
|
@event{EVT_PG_LABEL_EDIT_BEGIN(id, func)}
|
||||||
Respond to wxEVT_PG_LABEL_EDIT_BEGIN event, generated when user is
|
Respond to @c wxEVT_PG_LABEL_EDIT_BEGIN event, generated when user is
|
||||||
about to begin editing a property label. You can veto this event to
|
about to begin editing a property label. You can veto this event to
|
||||||
prevent the action.
|
prevent the action.
|
||||||
@event{EVT_PG_LABEL_EDIT_ENDING(id, func)}
|
@event{EVT_PG_LABEL_EDIT_ENDING(id, func)}
|
||||||
Respond to wxEVT_PG_LABEL_EDIT_ENDING event, generated when user is
|
Respond to @c wxEVT_PG_LABEL_EDIT_ENDING event, generated when user is
|
||||||
about to end editing of a property label. You can veto this event to
|
about to end editing of a property label. You can veto this event to
|
||||||
prevent the action.
|
prevent the action.
|
||||||
@event{EVT_PG_COL_BEGIN_DRAG(id, func)}
|
@event{EVT_PG_COL_BEGIN_DRAG(id, func)}
|
||||||
Respond to wxEVT_PG_COL_BEGIN_DRAG event, generated when user
|
Respond to @c wxEVT_PG_COL_BEGIN_DRAG event, generated when user
|
||||||
starts resizing a column - can be vetoed.
|
starts resizing a column - can be vetoed.
|
||||||
@event{EVT_PG_COL_DRAGGING,(id, func)}
|
@event{EVT_PG_COL_DRAGGING,(id, func)}
|
||||||
Respond to wxEVT_PG_COL_DRAGGING, event, generated when a
|
Respond to @c wxEVT_PG_COL_DRAGGING, event, generated when a
|
||||||
column resize by user is in progress. This event is also generated
|
column resize by user is in progress. This event is also generated
|
||||||
when user double-clicks the splitter in order to recenter
|
when user double-clicks the splitter in order to recenter
|
||||||
it.
|
it.
|
||||||
@event{EVT_PG_COL_END_DRAG(id, func)}
|
@event{EVT_PG_COL_END_DRAG(id, func)}
|
||||||
Respond to wxEVT_PG_COL_END_DRAG event, generated after column
|
Respond to @c wxEVT_PG_COL_END_DRAG event, generated after column
|
||||||
resize by user has finished.
|
resize by user has finished.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
@@ -579,7 +579,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
Forces updating the value of property from the editor control.
|
Forces updating the value of property from the editor control.
|
||||||
Note that wxEVT_PG_CHANGING and wxEVT_PG_CHANGED are dispatched using
|
Note that @c wxEVT_PG_CHANGING and @c wxEVT_PG_CHANGED are dispatched using
|
||||||
ProcessEvent, meaning your event handlers will be called immediately.
|
ProcessEvent, meaning your event handlers will be called immediately.
|
||||||
|
|
||||||
@return Returns @true if anything was changed.
|
@return Returns @true if anything was changed.
|
||||||
@@ -937,7 +937,7 @@ public:
|
|||||||
fails if current value in editor is not valid.
|
fails if current value in editor is not valid.
|
||||||
|
|
||||||
@remarks In wxPropertyGrid 1.4, this member function used to generate
|
@remarks In wxPropertyGrid 1.4, this member function used to generate
|
||||||
wxEVT_PG_SELECTED. In wxWidgets 2.9 and later, it no longer
|
@c wxEVT_PG_SELECTED. In wxWidgets 2.9 and later, it no longer
|
||||||
does that.
|
does that.
|
||||||
|
|
||||||
@remarks This clears any previous selection.
|
@remarks This clears any previous selection.
|
||||||
@@ -1236,7 +1236,7 @@ public:
|
|||||||
Returns property associated with this event.
|
Returns property associated with this event.
|
||||||
|
|
||||||
@remarks You should assume that this property can always be NULL.
|
@remarks You should assume that this property can always be NULL.
|
||||||
For instance, wxEVT_PG_SELECTED is emitted not only when
|
For instance, @c wxEVT_PG_SELECTED is emitted not only when
|
||||||
a new property is selected, but also when selection is
|
a new property is selected, but also when selection is
|
||||||
cleared by user activity.
|
cleared by user activity.
|
||||||
*/
|
*/
|
||||||
@@ -1258,7 +1258,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
Returns value of the associated property. Works for all event
|
Returns value of the associated property. Works for all event
|
||||||
types, but for wxEVT_PG_CHANGING this member function returns
|
types, but for @c wxEVT_PG_CHANGING this member function returns
|
||||||
the value that is pending, so you can call Veto() if the
|
the value that is pending, so you can call Veto() if the
|
||||||
value is not satisfactory.
|
value is not satisfactory.
|
||||||
|
|
||||||
@@ -1283,7 +1283,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
Set override validation failure behavior. Only effective if Veto() was
|
Set override validation failure behavior. Only effective if Veto() was
|
||||||
also called, and only allowed if event type is wxEVT_PG_CHANGING.
|
also called, and only allowed if event type is @c wxEVT_PG_CHANGING.
|
||||||
*/
|
*/
|
||||||
void SetValidationFailureBehavior( wxPGVFBFlags flags );
|
void SetValidationFailureBehavior( wxPGVFBFlags flags );
|
||||||
|
|
||||||
@@ -1298,7 +1298,7 @@ public:
|
|||||||
signaling. You can only veto a shutdown if wxPropertyGridEvent::CanVeto()
|
signaling. You can only veto a shutdown if wxPropertyGridEvent::CanVeto()
|
||||||
returns true.
|
returns true.
|
||||||
|
|
||||||
@remarks Currently only wxEVT_PG_CHANGING supports vetoing.
|
@remarks Currently only @c wxEVT_PG_CHANGING supports vetoing.
|
||||||
*/
|
*/
|
||||||
void Veto( bool veto = true );
|
void Veto( bool veto = true );
|
||||||
|
|
||||||
|
@@ -154,8 +154,8 @@ public:
|
|||||||
|
|
||||||
wxRichTextCtrl sends notification events: see wxRichTextEvent.
|
wxRichTextCtrl sends notification events: see wxRichTextEvent.
|
||||||
|
|
||||||
It also sends the standard wxTextCtrl events wxEVT_COMMAND_TEXT_ENTER and
|
It also sends the standard wxTextCtrl events @c wxEVT_COMMAND_TEXT_ENTER and
|
||||||
wxEVT_COMMAND_TEXT_UPDATED, and wxTextUrlEvent when URL content is clicked.
|
@c wxEVT_COMMAND_TEXT_UPDATED, and wxTextUrlEvent when URL content is clicked.
|
||||||
|
|
||||||
For more information, see the @ref overview_richtextctrl.
|
For more information, see the @ref overview_richtextctrl.
|
||||||
|
|
||||||
|
@@ -52,10 +52,10 @@ enum wxSashDragStatus
|
|||||||
|
|
||||||
@beginEventEmissionTable{wxSashEvent}
|
@beginEventEmissionTable{wxSashEvent}
|
||||||
@event{EVT_SASH_DRAGGED(id, func)}
|
@event{EVT_SASH_DRAGGED(id, func)}
|
||||||
Process a wxEVT_SASH_DRAGGED event, when the user has finished
|
Process a @c wxEVT_SASH_DRAGGED event, when the user has finished
|
||||||
dragging a sash.
|
dragging a sash.
|
||||||
@event{EVT_SASH_DRAGGED_RANGE(id1, id2, func)}
|
@event{EVT_SASH_DRAGGED_RANGE(id1, id2, func)}
|
||||||
Process a wxEVT_SASH_DRAGGED_RANGE event, when the user has
|
Process a @c wxEVT_SASH_DRAGGED_RANGE event, when the user has
|
||||||
finished dragging a sash. The event handler is called when windows
|
finished dragging a sash. The event handler is called when windows
|
||||||
with ids in the given range have their sashes dragged.
|
with ids in the given range have their sashes dragged.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
@@ -212,9 +212,9 @@ public:
|
|||||||
|
|
||||||
@beginEventTable{wxSashEvent}
|
@beginEventTable{wxSashEvent}
|
||||||
@event{EVT_SASH_DRAGGED(id, func)}
|
@event{EVT_SASH_DRAGGED(id, func)}
|
||||||
Process a wxEVT_SASH_DRAGGED event, when the user has finished dragging a sash.
|
Process a @c wxEVT_SASH_DRAGGED event, when the user has finished dragging a sash.
|
||||||
@event{EVT_SASH_DRAGGED_RANGE(id1, id2, func)}
|
@event{EVT_SASH_DRAGGED_RANGE(id1, id2, func)}
|
||||||
Process a wxEVT_SASH_DRAGGED_RANGE event, when the user has finished
|
Process a @c wxEVT_SASH_DRAGGED_RANGE event, when the user has finished
|
||||||
dragging a sash. The event handler is called when windows with ids in
|
dragging a sash. The event handler is called when windows with ids in
|
||||||
the given range have their sashes dragged.
|
the given range have their sashes dragged.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
@@ -47,45 +47,45 @@
|
|||||||
@event{EVT_SCROLL(func)}
|
@event{EVT_SCROLL(func)}
|
||||||
Process all scroll events.
|
Process all scroll events.
|
||||||
@event{EVT_SCROLL_TOP(func)}
|
@event{EVT_SCROLL_TOP(func)}
|
||||||
Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
|
Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
|
||||||
@event{EVT_SCROLL_BOTTOM(func)}
|
@event{EVT_SCROLL_BOTTOM(func)}
|
||||||
Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
|
Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
|
||||||
@event{EVT_SCROLL_LINEUP(func)}
|
@event{EVT_SCROLL_LINEUP(func)}
|
||||||
Process wxEVT_SCROLL_LINEUP line up events.
|
Process @c wxEVT_SCROLL_LINEUP line up events.
|
||||||
@event{EVT_SCROLL_LINEDOWN(func)}
|
@event{EVT_SCROLL_LINEDOWN(func)}
|
||||||
Process wxEVT_SCROLL_LINEDOWN line down events.
|
Process @c wxEVT_SCROLL_LINEDOWN line down events.
|
||||||
@event{EVT_SCROLL_PAGEUP(func)}
|
@event{EVT_SCROLL_PAGEUP(func)}
|
||||||
Process wxEVT_SCROLL_PAGEUP page up events.
|
Process @c wxEVT_SCROLL_PAGEUP page up events.
|
||||||
@event{EVT_SCROLL_PAGEDOWN(func)}
|
@event{EVT_SCROLL_PAGEDOWN(func)}
|
||||||
Process wxEVT_SCROLL_PAGEDOWN page down events.
|
Process @c wxEVT_SCROLL_PAGEDOWN page down events.
|
||||||
@event{EVT_SCROLL_THUMBTRACK(func)}
|
@event{EVT_SCROLL_THUMBTRACK(func)}
|
||||||
Process wxEVT_SCROLL_THUMBTRACK thumbtrack events
|
Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events
|
||||||
(frequent events sent as the user drags the thumbtrack).
|
(frequent events sent as the user drags the thumbtrack).
|
||||||
@event{EVT_SCROLL_THUMBRELEASE(func)}
|
@event{EVT_SCROLL_THUMBRELEASE(func)}
|
||||||
Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
|
Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
|
||||||
@event{EVT_SCROLL_CHANGED(func)}
|
@event{EVT_SCROLL_CHANGED(func)}
|
||||||
Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
|
Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
|
||||||
@event{EVT_COMMAND_SCROLL(id, func)}
|
@event{EVT_COMMAND_SCROLL(id, func)}
|
||||||
Process all scroll events.
|
Process all scroll events.
|
||||||
@event{EVT_COMMAND_SCROLL_TOP(id, func)}
|
@event{EVT_COMMAND_SCROLL_TOP(id, func)}
|
||||||
Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
|
Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
|
||||||
@event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
|
@event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
|
||||||
Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
|
Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
|
||||||
@event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
|
@event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
|
||||||
Process wxEVT_SCROLL_LINEUP line up events.
|
Process @c wxEVT_SCROLL_LINEUP line up events.
|
||||||
@event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
|
@event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
|
||||||
Process wxEVT_SCROLL_LINEDOWN line down events.
|
Process @c wxEVT_SCROLL_LINEDOWN line down events.
|
||||||
@event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
|
@event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
|
||||||
Process wxEVT_SCROLL_PAGEUP page up events.
|
Process @c wxEVT_SCROLL_PAGEUP page up events.
|
||||||
@event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
|
@event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
|
||||||
Process wxEVT_SCROLL_PAGEDOWN page down events.
|
Process @c wxEVT_SCROLL_PAGEDOWN page down events.
|
||||||
@event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
|
@event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
|
||||||
Process wxEVT_SCROLL_THUMBTRACK thumbtrack events
|
Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events
|
||||||
(frequent events sent as the user drags the thumbtrack).
|
(frequent events sent as the user drags the thumbtrack).
|
||||||
@event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
|
@event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
|
||||||
Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
|
Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
|
||||||
@event{EVT_COMMAND_SCROLL_CHANGED(func)}
|
@event{EVT_COMMAND_SCROLL_CHANGED(func)}
|
||||||
Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
|
Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
@section scrollbar_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
|
@section scrollbar_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
|
||||||
|
@@ -60,45 +60,45 @@
|
|||||||
@event{EVT_SCROLL(func)}
|
@event{EVT_SCROLL(func)}
|
||||||
Process all scroll events.
|
Process all scroll events.
|
||||||
@event{EVT_SCROLL_TOP(func)}
|
@event{EVT_SCROLL_TOP(func)}
|
||||||
Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
|
Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
|
||||||
@event{EVT_SCROLL_BOTTOM(func)}
|
@event{EVT_SCROLL_BOTTOM(func)}
|
||||||
Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
|
Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
|
||||||
@event{EVT_SCROLL_LINEUP(func)}
|
@event{EVT_SCROLL_LINEUP(func)}
|
||||||
Process wxEVT_SCROLL_LINEUP line up events.
|
Process @c wxEVT_SCROLL_LINEUP line up events.
|
||||||
@event{EVT_SCROLL_LINEDOWN(func)}
|
@event{EVT_SCROLL_LINEDOWN(func)}
|
||||||
Process wxEVT_SCROLL_LINEDOWN line down events.
|
Process @c wxEVT_SCROLL_LINEDOWN line down events.
|
||||||
@event{EVT_SCROLL_PAGEUP(func)}
|
@event{EVT_SCROLL_PAGEUP(func)}
|
||||||
Process wxEVT_SCROLL_PAGEUP page up events.
|
Process @c wxEVT_SCROLL_PAGEUP page up events.
|
||||||
@event{EVT_SCROLL_PAGEDOWN(func)}
|
@event{EVT_SCROLL_PAGEDOWN(func)}
|
||||||
Process wxEVT_SCROLL_PAGEDOWN page down events.
|
Process @c wxEVT_SCROLL_PAGEDOWN page down events.
|
||||||
@event{EVT_SCROLL_THUMBTRACK(func)}
|
@event{EVT_SCROLL_THUMBTRACK(func)}
|
||||||
Process wxEVT_SCROLL_THUMBTRACK thumbtrack events
|
Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events
|
||||||
(frequent events sent as the user drags the thumbtrack).
|
(frequent events sent as the user drags the thumbtrack).
|
||||||
@event{EVT_SCROLL_THUMBRELEASE(func)}
|
@event{EVT_SCROLL_THUMBRELEASE(func)}
|
||||||
Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
|
Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
|
||||||
@event{EVT_SCROLL_CHANGED(func)}
|
@event{EVT_SCROLL_CHANGED(func)}
|
||||||
Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
|
Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
|
||||||
@event{EVT_COMMAND_SCROLL(id, func)}
|
@event{EVT_COMMAND_SCROLL(id, func)}
|
||||||
Process all scroll events.
|
Process all scroll events.
|
||||||
@event{EVT_COMMAND_SCROLL_TOP(id, func)}
|
@event{EVT_COMMAND_SCROLL_TOP(id, func)}
|
||||||
Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
|
Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
|
||||||
@event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
|
@event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
|
||||||
Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
|
Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
|
||||||
@event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
|
@event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
|
||||||
Process wxEVT_SCROLL_LINEUP line up events.
|
Process @c wxEVT_SCROLL_LINEUP line up events.
|
||||||
@event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
|
@event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
|
||||||
Process wxEVT_SCROLL_LINEDOWN line down events.
|
Process @c wxEVT_SCROLL_LINEDOWN line down events.
|
||||||
@event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
|
@event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
|
||||||
Process wxEVT_SCROLL_PAGEUP page up events.
|
Process @c wxEVT_SCROLL_PAGEUP page up events.
|
||||||
@event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
|
@event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
|
||||||
Process wxEVT_SCROLL_PAGEDOWN page down events.
|
Process @c wxEVT_SCROLL_PAGEDOWN page down events.
|
||||||
@event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
|
@event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
|
||||||
Process wxEVT_SCROLL_THUMBTRACK thumbtrack events
|
Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events
|
||||||
(frequent events sent as the user drags the thumbtrack).
|
(frequent events sent as the user drags the thumbtrack).
|
||||||
@event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
|
@event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
|
||||||
Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
|
Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
|
||||||
@event{EVT_COMMAND_SCROLL_CHANGED(func)}
|
@event{EVT_COMMAND_SCROLL_CHANGED(func)}
|
||||||
Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
|
Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
@section slider_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
|
@section slider_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
|
||||||
|
@@ -17,7 +17,7 @@
|
|||||||
@style{wxSP_WRAP}
|
@style{wxSP_WRAP}
|
||||||
The value wraps at the minimum and maximum.
|
The value wraps at the minimum and maximum.
|
||||||
@style{wxTE_PROCESS_ENTER}
|
@style{wxTE_PROCESS_ENTER}
|
||||||
Indicates that the control should generate wxEVT_COMMAND_TEXT_ENTER
|
Indicates that the control should generate @c wxEVT_COMMAND_TEXT_ENTER
|
||||||
events. Using this style will prevent the user from using the Enter key
|
events. Using this style will prevent the user from using the Enter key
|
||||||
for dialog navigation (e.g. activating the default button in the
|
for dialog navigation (e.g. activating the default button in the
|
||||||
dialog) under MSW.
|
dialog) under MSW.
|
||||||
|
@@ -42,17 +42,17 @@
|
|||||||
The sash position is in the process of being changed.
|
The sash position is in the process of being changed.
|
||||||
May be used to modify the position of the tracking bar to properly
|
May be used to modify the position of the tracking bar to properly
|
||||||
reflect the position that would be set if the drag were to be completed
|
reflect the position that would be set if the drag were to be completed
|
||||||
at this point. Processes a wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING event.
|
at this point. Processes a @c wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING event.
|
||||||
@event{EVT_SPLITTER_SASH_POS_CHANGED(id, func)}
|
@event{EVT_SPLITTER_SASH_POS_CHANGED(id, func)}
|
||||||
The sash position was changed. May be used to modify the sash position
|
The sash position was changed. May be used to modify the sash position
|
||||||
before it is set, or to prevent the change from taking place.
|
before it is set, or to prevent the change from taking place.
|
||||||
Processes a wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED event.
|
Processes a @c wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED event.
|
||||||
@event{EVT_SPLITTER_UNSPLIT(id, func)}
|
@event{EVT_SPLITTER_UNSPLIT(id, func)}
|
||||||
The splitter has been just unsplit. Processes a wxEVT_COMMAND_SPLITTER_UNSPLIT event.
|
The splitter has been just unsplit. Processes a @c wxEVT_COMMAND_SPLITTER_UNSPLIT event.
|
||||||
@event{EVT_SPLITTER_DCLICK(id, func)}
|
@event{EVT_SPLITTER_DCLICK(id, func)}
|
||||||
The sash was double clicked. The default behaviour is to unsplit the
|
The sash was double clicked. The default behaviour is to unsplit the
|
||||||
window when this happens (unless the minimum pane size has been set
|
window when this happens (unless the minimum pane size has been set
|
||||||
to a value greater than zero). Processes a wxEVT_COMMAND_SPLITTER_DOUBLECLICKED event.
|
to a value greater than zero). Processes a @c wxEVT_COMMAND_SPLITTER_DOUBLECLICKED event.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
|
|
||||||
@@ -410,17 +410,17 @@ public:
|
|||||||
The sash position is in the process of being changed.
|
The sash position is in the process of being changed.
|
||||||
May be used to modify the position of the tracking bar to properly
|
May be used to modify the position of the tracking bar to properly
|
||||||
reflect the position that would be set if the drag were to be completed
|
reflect the position that would be set if the drag were to be completed
|
||||||
at this point. Processes a wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING event.
|
at this point. Processes a @c wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING event.
|
||||||
@event{EVT_SPLITTER_SASH_POS_CHANGED(id, func)}
|
@event{EVT_SPLITTER_SASH_POS_CHANGED(id, func)}
|
||||||
The sash position was changed. May be used to modify the sash position
|
The sash position was changed. May be used to modify the sash position
|
||||||
before it is set, or to prevent the change from taking place.
|
before it is set, or to prevent the change from taking place.
|
||||||
Processes a wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED event.
|
Processes a @c wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED event.
|
||||||
@event{EVT_SPLITTER_UNSPLIT(id, func)}
|
@event{EVT_SPLITTER_UNSPLIT(id, func)}
|
||||||
The splitter has been just unsplit. Processes a wxEVT_COMMAND_SPLITTER_UNSPLIT event.
|
The splitter has been just unsplit. Processes a @c wxEVT_COMMAND_SPLITTER_UNSPLIT event.
|
||||||
@event{EVT_SPLITTER_DCLICK(id, func)}
|
@event{EVT_SPLITTER_DCLICK(id, func)}
|
||||||
The sash was double clicked. The default behaviour is to unsplit the
|
The sash was double clicked. The default behaviour is to unsplit the
|
||||||
window when this happens (unless the minimum pane size has been set
|
window when this happens (unless the minimum pane size has been set
|
||||||
to a value greater than zero). Processes a wxEVT_COMMAND_SPLITTER_DOUBLECLICKED event.
|
to a value greater than zero). Processes a @c wxEVT_COMMAND_SPLITTER_DOUBLECLICKED event.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
@library{wxcore}
|
@library{wxcore}
|
||||||
|
@@ -14,11 +14,11 @@
|
|||||||
|
|
||||||
@beginStyleTable
|
@beginStyleTable
|
||||||
@style{wxTE_PROCESS_ENTER}
|
@style{wxTE_PROCESS_ENTER}
|
||||||
The control will generate the event wxEVT_COMMAND_TEXT_ENTER
|
The control will generate the event @c wxEVT_COMMAND_TEXT_ENTER
|
||||||
(otherwise pressing Enter key is either processed internally by the
|
(otherwise pressing Enter key is either processed internally by the
|
||||||
control or used for navigation between dialog controls).
|
control or used for navigation between dialog controls).
|
||||||
@style{wxTE_PROCESS_TAB}
|
@style{wxTE_PROCESS_TAB}
|
||||||
The control will receive wxEVT_CHAR events for TAB pressed -
|
The control will receive @c wxEVT_CHAR events for TAB pressed -
|
||||||
normally, TAB is used for passing to the next control in a dialog
|
normally, TAB is used for passing to the next control in a dialog
|
||||||
instead. For the control created with this style, you can still use
|
instead. For the control created with this style, you can still use
|
||||||
Ctrl-Enter to pass to the next control from the keyboard.
|
Ctrl-Enter to pass to the next control from the keyboard.
|
||||||
@@ -43,13 +43,13 @@
|
|||||||
To retrieve actual search queries, use EVT_TEXT and EVT_TEXT_ENTER events,
|
To retrieve actual search queries, use EVT_TEXT and EVT_TEXT_ENTER events,
|
||||||
just as you would with wxTextCtrl.
|
just as you would with wxTextCtrl.
|
||||||
@event{EVT_SEARCHCTRL_SEARCH_BTN(id, func)}
|
@event{EVT_SEARCHCTRL_SEARCH_BTN(id, func)}
|
||||||
Respond to a wxEVT_SEARCHCTRL_SEARCH_BTN event, generated when the
|
Respond to a @c wxEVT_SEARCHCTRL_SEARCH_BTN event, generated when the
|
||||||
search button is clicked. Note that this does not initiate a search on
|
search button is clicked. Note that this does not initiate a search on
|
||||||
its own, you need to perform the appropriate action in your event
|
its own, you need to perform the appropriate action in your event
|
||||||
handler. You may use @code event.GetString() @endcode to retrieve the
|
handler. You may use @code event.GetString() @endcode to retrieve the
|
||||||
string to search for in the event handler code.
|
string to search for in the event handler code.
|
||||||
@event{EVT_SEARCHCTRL_CANCEL_BTN(id, func)}
|
@event{EVT_SEARCHCTRL_CANCEL_BTN(id, func)}
|
||||||
Respond to a wxEVT_SEARCHCTRL_CANCEL_BTN event, generated when the
|
Respond to a @c wxEVT_SEARCHCTRL_CANCEL_BTN event, generated when the
|
||||||
cancel button is clicked.
|
cancel button is clicked.
|
||||||
@endEventTable
|
@endEventTable
|
||||||
|
|
||||||
|
@@ -53,19 +53,19 @@ public:
|
|||||||
to override wxTaskBarIcon::CreatePopupMenu() if all that the application does
|
to override wxTaskBarIcon::CreatePopupMenu() if all that the application does
|
||||||
is that it shows a popup menu in reaction to mouse click.
|
is that it shows a popup menu in reaction to mouse click.
|
||||||
@event{EVT_TASKBAR_MOVE(func)}
|
@event{EVT_TASKBAR_MOVE(func)}
|
||||||
Process a wxEVT_TASKBAR_MOVE event.
|
Process a @c wxEVT_TASKBAR_MOVE event.
|
||||||
@event{EVT_TASKBAR_LEFT_DOWN(func)}
|
@event{EVT_TASKBAR_LEFT_DOWN(func)}
|
||||||
Process a wxEVT_TASKBAR_LEFT_DOWN event.
|
Process a @c wxEVT_TASKBAR_LEFT_DOWN event.
|
||||||
@event{EVT_TASKBAR_LEFT_UP(func)}
|
@event{EVT_TASKBAR_LEFT_UP(func)}
|
||||||
Process a wxEVT_TASKBAR_LEFT_UP event.
|
Process a @c wxEVT_TASKBAR_LEFT_UP event.
|
||||||
@event{EVT_TASKBAR_RIGHT_DOWN(func)}
|
@event{EVT_TASKBAR_RIGHT_DOWN(func)}
|
||||||
Process a wxEVT_TASKBAR_RIGHT_DOWN event.
|
Process a @c wxEVT_TASKBAR_RIGHT_DOWN event.
|
||||||
@event{EVT_TASKBAR_RIGHT_UP(func)}
|
@event{EVT_TASKBAR_RIGHT_UP(func)}
|
||||||
Process a wxEVT_TASKBAR_RIGHT_UP event.
|
Process a @c wxEVT_TASKBAR_RIGHT_UP event.
|
||||||
@event{EVT_TASKBAR_LEFT_DCLICK(func)}
|
@event{EVT_TASKBAR_LEFT_DCLICK(func)}
|
||||||
Process a wxEVT_TASKBAR_LEFT_DCLICK event.
|
Process a @c wxEVT_TASKBAR_LEFT_DCLICK event.
|
||||||
@event{EVT_TASKBAR_RIGHT_DCLICK(func)}
|
@event{EVT_TASKBAR_RIGHT_DCLICK(func)}
|
||||||
Process a wxEVT_TASKBAR_RIGHT_DCLICK event.
|
Process a @c wxEVT_TASKBAR_RIGHT_DCLICK event.
|
||||||
@event{EVT_TASKBAR_CLICK(func)}
|
@event{EVT_TASKBAR_CLICK(func)}
|
||||||
This is a synonym for either EVT_TASKBAR_RIGHT_DOWN or UP depending on
|
This is a synonym for either EVT_TASKBAR_RIGHT_DOWN or UP depending on
|
||||||
the platform, use this event macro to catch the event which should result
|
the platform, use this event macro to catch the event which should result
|
||||||
|
@@ -854,11 +854,11 @@ public:
|
|||||||
|
|
||||||
@beginStyleTable
|
@beginStyleTable
|
||||||
@style{wxTE_PROCESS_ENTER}
|
@style{wxTE_PROCESS_ENTER}
|
||||||
The control will generate the event wxEVT_COMMAND_TEXT_ENTER
|
The control will generate the event @c wxEVT_COMMAND_TEXT_ENTER
|
||||||
(otherwise pressing Enter key is either processed internally by the
|
(otherwise pressing Enter key is either processed internally by the
|
||||||
control or used for navigation between dialog controls).
|
control or used for navigation between dialog controls).
|
||||||
@style{wxTE_PROCESS_TAB}
|
@style{wxTE_PROCESS_TAB}
|
||||||
The control will receive wxEVT_CHAR events for TAB pressed -
|
The control will receive @c wxEVT_CHAR events for TAB pressed -
|
||||||
normally, TAB is used for passing to the next control in a dialog
|
normally, TAB is used for passing to the next control in a dialog
|
||||||
instead. For the control created with this style, you can still use
|
instead. For the control created with this style, you can still use
|
||||||
Ctrl-Enter to pass to the next control from the keyboard.
|
Ctrl-Enter to pass to the next control from the keyboard.
|
||||||
@@ -1049,14 +1049,14 @@ public:
|
|||||||
|
|
||||||
@beginEventEmissionTable{wxCommandEvent}
|
@beginEventEmissionTable{wxCommandEvent}
|
||||||
@event{EVT_TEXT(id, func)}
|
@event{EVT_TEXT(id, func)}
|
||||||
Respond to a wxEVT_COMMAND_TEXT_UPDATED event, generated when the text
|
Respond to a @c wxEVT_COMMAND_TEXT_UPDATED event, generated when the text
|
||||||
changes. Notice that this event will be sent when the text controls
|
changes. Notice that this event will be sent when the text controls
|
||||||
contents changes -- whether this is due to user input or comes from the
|
contents changes -- whether this is due to user input or comes from the
|
||||||
program itself (for example, if wxTextCtrl::SetValue() is called); see
|
program itself (for example, if wxTextCtrl::SetValue() is called); see
|
||||||
wxTextCtrl::ChangeValue() for a function which does not send this event.
|
wxTextCtrl::ChangeValue() for a function which does not send this event.
|
||||||
This event is however not sent during the control creation.
|
This event is however not sent during the control creation.
|
||||||
@event{EVT_TEXT_ENTER(id, func)}
|
@event{EVT_TEXT_ENTER(id, func)}
|
||||||
Respond to a wxEVT_COMMAND_TEXT_ENTER event, generated when enter is
|
Respond to a @c wxEVT_COMMAND_TEXT_ENTER event, generated when enter is
|
||||||
pressed in a text control which must have wxTE_PROCESS_ENTER style for
|
pressed in a text control which must have wxTE_PROCESS_ENTER style for
|
||||||
this event to be generated.
|
this event to be generated.
|
||||||
@event{EVT_TEXT_URL(id, func)}
|
@event{EVT_TEXT_URL(id, func)}
|
||||||
|
Reference in New Issue
Block a user