From 8c6791e43ca1adb11db20674a2327dc5e354f629 Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Sun, 6 Apr 2008 14:43:04 +0000 Subject: [PATCH] improved rendering of styles and events sections: put the description of those items on new lines; put the prototype of event handlers on a separate line, too. This change requires that @event and @style macros are _not_ followed by a colon. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53043 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/doxygen/Doxyfile_inc | 24 +-- docs/doxygen/wxwidgets.css | 11 +- interface/animate.h | 4 +- interface/aui/auibook.h | 24 +-- interface/bmpbuttn.h | 12 +- interface/bmpcbox.h | 12 +- interface/button.h | 14 +- interface/calctrl.h | 22 +-- interface/checkbox.h | 10 +- interface/checklst.h | 2 +- interface/choicdlg.h | 12 +- interface/choice.h | 4 +- interface/choicebk.h | 14 +- interface/clrpicker.h | 6 +- interface/collpane.h | 2 +- interface/combo.h | 14 +- interface/combobox.h | 16 +- interface/dataview.h | 10 +- interface/datectrl.h | 12 +- interface/dialog.h | 26 +-- interface/dirdlg.h | 6 +- interface/editlbox.h | 10 +- interface/event.h | 250 ++++++++++++++-------------- interface/fdrepdlg.h | 10 +- interface/filectrl.h | 22 +-- interface/filedlg.h | 16 +- interface/filepicker.h | 22 +-- interface/fontpicker.h | 8 +- interface/frame.h | 34 ++-- interface/gauge.h | 6 +- interface/html/htmlwin.h | 6 +- interface/htmllbox.h | 4 +- interface/hyperlink.h | 10 +- interface/listbook.h | 10 +- interface/listbox.h | 18 +- interface/listctrl.h | 30 ++-- interface/mdi.h | 50 +++--- interface/minifram.h | 24 +-- interface/msgdlg.h | 16 +- interface/notebook.h | 16 +- interface/odcombo.h | 15 +- interface/pickerbase.h | 2 +- interface/progdlg.h | 16 +- interface/radiobox.h | 8 +- interface/radiobut.h | 8 +- interface/richtext/richtextstyles.h | 2 +- interface/sashwin.h | 12 +- interface/scrolbar.h | 4 +- interface/scrolwin.h | 2 +- interface/slider.h | 20 +-- interface/spinbutt.h | 8 +- interface/spinctrl.h | 4 +- interface/splitter.h | 16 +- interface/srchctrl.h | 14 +- interface/statline.h | 4 +- interface/stattext.h | 16 +- interface/statusbr.h | 2 +- interface/textctrl.h | 38 ++--- interface/tglbtn.h | 4 +- interface/toolbar.h | 26 +-- interface/toolbook.h | 4 +- interface/treectrl.h | 24 +-- interface/window.h | 44 ++--- 63 files changed, 560 insertions(+), 552 deletions(-) diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc index 80a91c1f47..3b15e08b4b 100644 --- a/docs/doxygen/Doxyfile_inc +++ b/docs/doxygen/Doxyfile_inc @@ -47,21 +47,21 @@ SUBGROUPING = YES # us to keep the headers readable and "implement" wxWidgets-specific commands. # event aliases -ALIASES = beginEventTable{1}="\nEvents:

The following event handler macros redirect the events to member functions with a prototype: void handler(\1& event)

" -ALIASES += event{1}="\li \1" -ALIASES += event{2}="\li \1, \2" -ALIASES += event{3}="\li \1, \2, \3" -ALIASES += event{4}="\li \1, \2, \3, \4" -ALIASES += endEventTable="\n" +ALIASES = beginEventTable{1}="\nEvents:

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(\1& event)


Event macros:
" +ALIASES += event{1}="
\li \1:
" +ALIASES += event{2}="
\li \1, \2:
" +ALIASES += event{3}="
\li \1, \2, \3:
" +ALIASES += event{4}="
\li \1, \2, \3, \4:
" +ALIASES += endEventTable="
\n" # style aliases -ALIASES += beginStyleTable="\nStyles:" -ALIASES += style{1}="\li \1" -ALIASES += endStyleTable="\n" +ALIASES += beginStyleTable="\nStyles:
" +ALIASES += style{1}="
\li \1:
" +ALIASES += endStyleTable="
\n" # extra style aliases -ALIASES += beginExtraStyleTable="
Extra styles:" -ALIASES += endExtraStyleTable="
" +ALIASES += beginExtraStyleTable="\nExtra styles:
" +ALIASES += endExtraStyleTable="
\n" # aliases for additional wx-specific infos ALIASES += category{1}="\ingroup group_class_\1 \n
Category:  \ref group_class_\1
" @@ -85,7 +85,7 @@ ALIASES += onlyfor{3}="
Availability:   ALIASES += onlyfor{4}="
Availability:  only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports.
\xmlonly \1,\2,\3,\4 \endxmlonly" # creates appearance section: this should be used for all main GUI controls -ALIASES += appearance{1}="@htmlonly
Appearance:
wxMSW appearancewxGTK appearancewxMac appearance
wxMSW appearancewxGTK appearancewxMac appearance
@endhtmlonly" +ALIASES += appearance{1}="@htmlonly
Appearance:
wxMSW appearancewxGTK appearancewxMac appearance
wxMSW appearancewxGTK appearancewxMac appearance
@endhtmlonly" # IMPORTANT: the \headerfile command does not work everywhere we'd need it, # e.g. in the constants page we need to specify an header file diff --git a/docs/doxygen/wxwidgets.css b/docs/doxygen/wxwidgets.css index 2a18613a4f..d5273d371a 100644 --- a/docs/doxygen/wxwidgets.css +++ b/docs/doxygen/wxwidgets.css @@ -491,7 +491,16 @@ SPAN.style, SPAN.event { color: #880000; } -SPAN.eventHandler { +DIV.styleDesc, DIV.eventDesc { + margin-left: 3%; + margin-bottom: 1ex; +} + +DIV.eventHandler { + text-indent: 3%; +} + +DIV.eventHandler SPAN { padding: 5px; background-color: #eeeeee; font-family: monospace, fixed; diff --git a/interface/animate.h b/interface/animate.h index 7fb3a9a3d5..f840408f43 100644 --- a/interface/animate.h +++ b/interface/animate.h @@ -37,9 +37,9 @@ enum wxAnimationType It is only available if @c wxUSE_ANIMATIONCTRL is set to 1 (the default). @beginStyleTable - @style{wxAC_DEFAULT_STYLE}: + @style{wxAC_DEFAULT_STYLE} The default style: wxBORDER_NONE. - @style{wxAC_NO_AUTORESIZE}: + @style{wxAC_NO_AUTORESIZE} By default, the control will adjust its size to exactly fit to the size of the animation when SetAnimation is called. If this style flag is given, the control will not change its size diff --git a/interface/aui/auibook.h b/interface/aui/auibook.h index bd8bd46e5c..b4d933eab3 100644 --- a/interface/aui/auibook.h +++ b/interface/aui/auibook.h @@ -28,30 +28,30 @@ The theme can be changed by calling wxAuiNotebook::SetArtProvider. @beginStyleTable - @style{wxAUI_NB_DEFAULT_STYLE}: + @style{wxAUI_NB_DEFAULT_STYLE} Defined as wxAUI_NB_TOP | wxAUI_NB_TAB_SPLIT | wxAUI_NB_TAB_MOVE | wxAUI_NB_SCROLL_BUTTONS | wxAUI_NB_CLOSE_ON_ACTIVE_TAB. - @style{wxAUI_NB_TAB_SPLIT}: + @style{wxAUI_NB_TAB_SPLIT} Allows the tab control to be split by dragging a tab. - @style{wxAUI_NB_TAB_MOVE}: + @style{wxAUI_NB_TAB_MOVE} Allows a tab to be moved horizontally by dragging. - @style{wxAUI_NB_TAB_EXTERNAL_MOVE}: + @style{wxAUI_NB_TAB_EXTERNAL_MOVE} Allows a tab to be moved to another tab control. - @style{wxAUI_NB_TAB_FIXED_WIDTH}: + @style{wxAUI_NB_TAB_FIXED_WIDTH} With this style, all tabs have the same width. - @style{wxAUI_NB_SCROLL_BUTTONS}: + @style{wxAUI_NB_SCROLL_BUTTONS} With this style, left and right scroll buttons are displayed. - @style{wxAUI_NB_WINDOWLIST_BUTTON}: + @style{wxAUI_NB_WINDOWLIST_BUTTON} With this style, a drop-down list of windows is available. - @style{wxAUI_NB_CLOSE_BUTTON}: + @style{wxAUI_NB_CLOSE_BUTTON} With this style, a close button is available on the tab bar. - @style{wxAUI_NB_CLOSE_ON_ACTIVE_TAB}: + @style{wxAUI_NB_CLOSE_ON_ACTIVE_TAB} With this style, the close button is visible on the active tab. - @style{wxAUI_NB_CLOSE_ON_ALL_TABS}: + @style{wxAUI_NB_CLOSE_ON_ALL_TABS} With this style, the close button is visible on all tabs. - @style{wxAUI_NB_TOP}: + @style{wxAUI_NB_TOP} With this style, tabs are drawn along the top of the notebook. - @style{wxAUI_NB_BOTTOM}: + @style{wxAUI_NB_BOTTOM} With this style, tabs are drawn along the bottom of the notebook. @endStyleTable diff --git a/interface/bmpbuttn.h b/interface/bmpbuttn.h index 66e175b6d3..6d80e607b7 100644 --- a/interface/bmpbuttn.h +++ b/interface/bmpbuttn.h @@ -35,19 +35,19 @@ to get reasonably good behaviour on all platforms. @beginStyleTable - @style{wxBU_AUTODRAW}: + @style{wxBU_AUTODRAW} If this is specified, the button will be drawn automatically using the label bitmap only, providing a 3D-look border. If this style is not specified, the button will be drawn without borders and using all provided bitmaps. Has effect only under MS Windows. - @style{wxBU_LEFT}: + @style{wxBU_LEFT} Left-justifies the bitmap label. Has effect only under MS Windows. - @style{wxBU_TOP}: + @style{wxBU_TOP} Aligns the bitmap label to the top of the button. Has effect only under MS Windows. - @style{wxBU_RIGHT}: + @style{wxBU_RIGHT} Right-justifies the bitmap label. Has effect only under MS Windows. - @style{wxBU_BOTTOM}: + @style{wxBU_BOTTOM} Aligns the bitmap label to the bottom of the button. Has effect only under MS Windows. @endStyleTable @@ -56,7 +56,7 @@ class as bitmap buttons don't have any minimal standard size by default. @beginEventTable{wxCommandEvent} - @event{EVT_BUTTON(id, func)}: + @event{EVT_BUTTON(id, func)} Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked. @endEventTable diff --git a/interface/bmpcbox.h b/interface/bmpcbox.h index 44f867b817..194bf7a95a 100644 --- a/interface/bmpcbox.h +++ b/interface/bmpcbox.h @@ -22,12 +22,12 @@ @c wxGENERIC_BITMAPCOMBOBOX is defined. @beginStyleTable - @style{wxCB_READONLY}: + @style{wxCB_READONLY} Creates a combobox without a text editor. On some platforms the control may appear very different when this style is used. - @style{wxCB_SORT}: + @style{wxCB_SORT} 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 (otherwise pressing Enter key is either processed internally by the control or used for navigation between dialog controls). @@ -37,12 +37,12 @@ @todo create wxCB_PROCESS_ENTER rather than reusing wxTE_PROCESS_ENTER! @beginEventTable{wxCommandEvent} - @event{EVT_COMBOBOX(id, func)}: + @event{EVT_COMBOBOX(id, func)} Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on 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. - @event{EVT_TEXT_ENTER(id, func)}: + @event{EVT_TEXT_ENTER(id, func)} Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in the combobox. @endEventTable diff --git a/interface/button.h b/interface/button.h index d912fca520..afb7dee205 100644 --- a/interface/button.h +++ b/interface/button.h @@ -17,23 +17,23 @@ or indeed on almost any other window. @beginStyleTable - @style{wxBU_LEFT}: + @style{wxBU_LEFT} Left-justifies the label. Windows and GTK+ only. - @style{wxBU_TOP}: + @style{wxBU_TOP} Aligns the label to the top of the button. Windows and GTK+ only. - @style{wxBU_RIGHT}: + @style{wxBU_RIGHT} Right-justifies the bitmap label. Windows and GTK+ only. - @style{wxBU_BOTTOM}: + @style{wxBU_BOTTOM} Aligns the label to the bottom of the button. Windows and GTK+ only. - @style{wxBU_EXACTFIT}: + @style{wxBU_EXACTFIT} Creates the button as small as possible instead of making it of the standard size (which is the default behaviour ). - @style{wxBORDER_NONE}: + @style{wxBORDER_NONE} Creates a flat button. Windows and GTK+ only. @endStyleTable @beginEventTable{wxCommandEvent} - @event{EVT_BUTTON(id, func)}: + @event{EVT_BUTTON(id, func)} Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked. @endEventTable diff --git a/interface/calctrl.h b/interface/calctrl.h index 9869e33a7f..bb1f25fcb7 100644 --- a/interface/calctrl.h +++ b/interface/calctrl.h @@ -221,32 +221,32 @@ enum wxCalendarHitTestResult @c EVT_CALENDAR_PAGE_CHANGED event handler. @beginStyleTable - @style{wxCAL_SUNDAY_FIRST}: + @style{wxCAL_SUNDAY_FIRST} Show Sunday as the first day in the week (not in wxGTK) - @style{wxCAL_MONDAY_FIRST}: + @style{wxCAL_MONDAY_FIRST} Show Monday as the first day in the week (not in wxGTK) - @style{wxCAL_SHOW_HOLIDAYS}: + @style{wxCAL_SHOW_HOLIDAYS} Highlight holidays in the calendar (only generic) - @style{wxCAL_NO_YEAR_CHANGE}: + @style{wxCAL_NO_YEAR_CHANGE} Disable the year changing (deprecated, only generic) - @style{wxCAL_NO_MONTH_CHANGE}: + @style{wxCAL_NO_MONTH_CHANGE} Disable the month (and, implicitly, the year) changing - @style{wxCAL_SHOW_SURROUNDING_WEEKS}: + @style{wxCAL_SHOW_SURROUNDING_WEEKS} Show the neighbouring weeks in the previous and next months (only generic, always on for the native controls) - @style{wxCAL_SEQUENTIAL_MONTH_SELECTION}: + @style{wxCAL_SEQUENTIAL_MONTH_SELECTION} Use alternative, more compact, style for the month and year selection controls. (only generic) @endStyleTable @beginEventTable{wxCalendarEvent} - @event{EVT_CALENDAR(id, func)}: + @event{EVT_CALENDAR(id, func)} A day was double clicked in the calendar. - @event{EVT_CALENDAR_SEL_CHANGED(id, func)}: + @event{EVT_CALENDAR_SEL_CHANGED(id, func)} The selected date changed. - @event{EVT_CALENDAR_PAGE_CHANGED(id, func)}: + @event{EVT_CALENDAR_PAGE_CHANGED(id, func)} The selected month (and/or year) changed. - @event{EVT_CALENDAR_WEEKDAY_CLICKED(id, func)}: + @event{EVT_CALENDAR_WEEKDAY_CLICKED(id, func)} User clicked on the week day header (only generic). @endEventTable diff --git a/interface/checkbox.h b/interface/checkbox.h index 66b60b3651..944f9b248c 100644 --- a/interface/checkbox.h +++ b/interface/checkbox.h @@ -27,21 +27,21 @@ enum wxCheckBoxState state. Often this is used as a "Does Not Apply" state. @beginStyleTable - @style{wxCHK_2STATE}: + @style{wxCHK_2STATE} Create a 2-state checkbox. This is the default. - @style{wxCHK_3STATE}: + @style{wxCHK_3STATE} Create a 3-state checkbox. Not implemented in wxMGL, wxOS2 and wxGTK built against GTK+ 1.2. - @style{wxCHK_ALLOW_3RD_STATE_FOR_USER}: + @style{wxCHK_ALLOW_3RD_STATE_FOR_USER} By default a user can't set a 3-state checkbox to the third state. It can only be done from code. Using this flags allows the user to set the checkbox to the third state by clicking. - @style{wxALIGN_RIGHT}: + @style{wxALIGN_RIGHT} Makes the text appear on the left of the checkbox. @endStyleTable @beginEventTable{wxCommandEvent} - @event{EVT_CHECKBOX(id, func)}: + @event{EVT_CHECKBOX(id, func)} Process a wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox is clicked. @endEventTable diff --git a/interface/checklst.h b/interface/checklst.h index d3d6d206fa..c8a6ee6073 100644 --- a/interface/checklst.h +++ b/interface/checklst.h @@ -22,7 +22,7 @@ and therefore this is not available to the application. @beginEventTable{wxCommandEvent} - @event{EVT_CHECKLISTBOX(id, func)}: + @event{EVT_CHECKLISTBOX(id, func)} Process a wxEVT_COMMAND_CHECKLISTBOX_TOGGLED event, when an item in the check list box is checked or unchecked. @endEventTable diff --git a/interface/choicdlg.h b/interface/choicdlg.h index 9e80604ee8..734cecc83c 100644 --- a/interface/choicdlg.h +++ b/interface/choicdlg.h @@ -44,11 +44,11 @@ public: Dialog position. Not Windows. @beginStyleTable - @style{wxOK}: + @style{wxOK} Show an OK button. - @style{wxCANCEL}: + @style{wxCANCEL} Show a Cancel button. - @style{wxCENTRE}: + @style{wxCENTRE} Centre the message. Not Windows. @endStyleTable @@ -136,11 +136,11 @@ public: Dialog position. Not Windows. @beginStyleTable - @style{wxOK}: + @style{wxOK} Show an OK button. - @style{wxCANCEL}: + @style{wxCANCEL} Show a Cancel button. - @style{wxCENTRE}: + @style{wxCENTRE} Centre the message. Not Windows. @endStyleTable diff --git a/interface/choice.h b/interface/choice.h index be6766bee6..a197296f39 100644 --- a/interface/choice.h +++ b/interface/choice.h @@ -15,12 +15,12 @@ menu of choices. @beginStyleTable - @style{wxCB_SORT}: + @style{wxCB_SORT} Sorts the entries alphabetically. @endStyleTable @beginEventTable{wxCommandEvent} - @event{EVT_CHOICE(id, func)}: + @event{EVT_CHOICE(id, func)} Process a wxEVT_COMMAND_CHOICE_SELECTED event, when an item on the list is selected. @endEventTable diff --git a/interface/choicebk.h b/interface/choicebk.h index dc8a9ee5db..879e4e024d 100644 --- a/interface/choicebk.h +++ b/interface/choicebk.h @@ -24,24 +24,24 @@ wxChoicebook is being employed. @beginStyleTable - @style{wxCHB_DEFAULT}: + @style{wxCHB_DEFAULT} Choose the default location for the labels depending on the current platform (left everywhere except Mac where it is top). - @style{wxCHB_TOP}: + @style{wxCHB_TOP} Place labels above the page area. - @style{wxCHB_LEFT}: + @style{wxCHB_LEFT} Place labels on the left side. - @style{wxCHB_RIGHT}: + @style{wxCHB_RIGHT} Place labels on the right side. - @style{wxCHB_BOTTOM}: + @style{wxCHB_BOTTOM} Place labels below the page area. @endStyleTable @beginEventTable{wxChoicebookEvent} - @event{EVT_CHOICEBOOK_PAGE_CHANGED(id, func)}: + @event{EVT_CHOICEBOOK_PAGE_CHANGED(id, func)} The page selection was changed. Processes a wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED event. - @event{EVT_CHOICEBOOK_PAGE_CHANGING(id, func)}: + @event{EVT_CHOICEBOOK_PAGE_CHANGING(id, func)} The page selection is about to be changed. Processes a wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING event. This event can be vetoed (using wxNotifyEvent::Veto()). diff --git a/interface/clrpicker.h b/interface/clrpicker.h index 387f99d1ab..32a89c6af8 100644 --- a/interface/clrpicker.h +++ b/interface/clrpicker.h @@ -18,15 +18,15 @@ It is only available if @c wxUSE_COLOURPICKERCTRL is set to 1 (the default). @beginStyleTable - @style{wxCLRP_DEFAULT_STYLE}: + @style{wxCLRP_DEFAULT_STYLE} The default style: 0. - @style{wxCLRP_USE_TEXTCTRL}: + @style{wxCLRP_USE_TEXTCTRL} Creates a text control to the left of the picker button which is completely managed by the wxColourPickerCtrl and which can be used by the user to specify a colour (see SetColour). The text control is automatically synchronized with button's value. Use functions defined in wxPickerBase to modify the text control. - @style{wxCLRP_SHOW_LABEL}: + @style{wxCLRP_SHOW_LABEL} Shows the colour in HTML form (AABBCC) as colour button label (instead of no label at all). @endStyleTable diff --git a/interface/collpane.h b/interface/collpane.h index 89a6e74e79..b8044004c8 100644 --- a/interface/collpane.h +++ b/interface/collpane.h @@ -88,7 +88,7 @@ public: It is only available if @c wxUSE_COLLPANE is set to 1 (the default). @beginStyleTable - @style{wxCP_DEFAULT_STYLE}: + @style{wxCP_DEFAULT_STYLE} The default style: 0. @endStyleTable diff --git a/interface/combo.h b/interface/combo.h index 40bd5c9123..7147eb84be 100644 --- a/interface/combo.h +++ b/interface/combo.h @@ -253,28 +253,28 @@ public: @endcode @beginStyleTable - @style{wxCB_READONLY}: + @style{wxCB_READONLY} Text will not be editable. - @style{wxCB_SORT}: + @style{wxCB_SORT} 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 (otherwise pressing Enter key is either processed internally by the control or used for navigation between dialog controls). Windows only. - @style{wxCC_SPECIAL_DCLICK}: + @style{wxCC_SPECIAL_DCLICK} Double-clicking triggers a call to popup's OnComboDoubleClick. Actual behaviour is defined by a derived class. For instance, wxOwnerDrawnComboBox will cycle an item. This style only applies if wxCB_READONLY is used as well. - @style{wxCC_STD_BUTTON}: + @style{wxCC_STD_BUTTON} Drop button will behave more like a standard push button. @endStyleTable @beginEventTable{wxCommandEvent} - @event{EVT_TEXT(id, func)}: + @event{EVT_TEXT(id, func)} Process a 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 the combo control. @endEventTable diff --git a/interface/combobox.h b/interface/combobox.h index 3613170011..62860ed93e 100644 --- a/interface/combobox.h +++ b/interface/combobox.h @@ -22,17 +22,17 @@ wxComboPopup and the ready-to-use wxBitmapComboBox. @beginStyleTable - @style{wxCB_SIMPLE}: + @style{wxCB_SIMPLE} Creates a combobox with a permanently displayed list. Windows only. - @style{wxCB_DROPDOWN}: + @style{wxCB_DROPDOWN} Creates a combobox with a drop-down list. - @style{wxCB_READONLY}: + @style{wxCB_READONLY} Same as wxCB_DROPDOWN but only the strings specified as the combobox choices can be selected, it is impossible to select (even from a program) a string which is not in the choices list. - @style{wxCB_SORT}: + @style{wxCB_SORT} 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 (otherwise pressing Enter key is either processed internally by the control or used for navigation between dialog controls). Windows @@ -40,14 +40,14 @@ @endStyleTable @beginEventTable{wxCommandEvent} - @event{EVT_COMBOBOX(id, func)}: + @event{EVT_COMBOBOX(id, func)} Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on the list is selected. Note that calling GetValue returns the new value of selection. - @event{EVT_TEXT(id, func)}: + @event{EVT_TEXT(id, func)} Process a 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 the combobox (notice that the combobox must have been created with wxTE_PROCESS_ENTER style to receive this event). diff --git a/interface/dataview.h b/interface/dataview.h index 339b1bfaa9..7c1be3f2b5 100644 --- a/interface/dataview.h +++ b/interface/dataview.h @@ -805,15 +805,15 @@ public: from wxVariant::GetType. @beginStyleTable - @style{wxDV_SINGLE}: + @style{wxDV_SINGLE} Single selection mode. This is the default. - @style{wxDV_MULTIPLE}: + @style{wxDV_MULTIPLE} Multiple selection mode. - @style{wxDV_ROW_LINES}: + @style{wxDV_ROW_LINES} Use alternating colours for rows if supported by platform and theme. - @style{wxDV_HORIZ_RULES}: + @style{wxDV_HORIZ_RULES} Display fine rules between row if supported. - @style{wxDV_VERT_RULES}: + @style{wxDV_VERT_RULES} Display fine rules between columns is supported. @endStyleTable diff --git a/interface/datectrl.h b/interface/datectrl.h index 501b03cc9d..5c55af5a13 100644 --- a/interface/datectrl.h +++ b/interface/datectrl.h @@ -21,29 +21,29 @@ It is only available if @c wxUSE_DATEPICKCTRL is set to 1. @beginStyleTable - @style{wxDP_SPIN}: + @style{wxDP_SPIN} Creates a control without a month calendar drop down but with spin-control-like arrows to change individual date components. This style is not supported by the generic version. - @style{wxDP_DROPDOWN}: + @style{wxDP_DROPDOWN} Creates a control with a month calendar drop-down part from which the user can select a date. - @style{wxDP_DEFAULT}: + @style{wxDP_DEFAULT} Creates a control with the style that is best supported for the current platform (currently wxDP_SPIN under Windows and wxDP_DROPDOWN elsewhere). - @style{wxDP_ALLOWNONE}: + @style{wxDP_ALLOWNONE} With this style, the control allows the user to not enter any valid date at all. Without it - the default - the control always has some valid date. - @style{wxDP_SHOWCENTURY}: + @style{wxDP_SHOWCENTURY} Forces display of the century in the default date format. Without this style the century could be displayed, or not, depending on the default date representation in the system. @endStyleTable @beginEventTable{wxDateEvent} - @event{EVT_DATE_CHANGED(id, func)}: + @event{EVT_DATE_CHANGED(id, func)} This event fires when the user changes the current selection in the control. @endEventTable diff --git a/interface/dialog.h b/interface/dialog.h index 73543c1f58..6c34363b9f 100644 --- a/interface/dialog.h +++ b/interface/dialog.h @@ -18,41 +18,41 @@ overview_autoscrollingdialogs "Automatic scrolling dialogs" for further details. @beginStyleTable - @style{wxCAPTION}: + @style{wxCAPTION} Puts a caption on the dialog box. - @style{wxDEFAULT_DIALOG_STYLE}: + @style{wxDEFAULT_DIALOG_STYLE} Equivalent to a combination of wxCAPTION, wxCLOSE_BOX and wxSYSTEM_MENU (the last one is not used under Unix) - @style{wxRESIZE_BORDER}: + @style{wxRESIZE_BORDER} Display a resizeable frame around the window. - @style{wxSYSTEM_MENU}: + @style{wxSYSTEM_MENU} Display a system menu. - @style{wxCLOSE_BOX}: + @style{wxCLOSE_BOX} Displays a close box on the frame. - @style{wxMAXIMIZE_BOX}: + @style{wxMAXIMIZE_BOX} Displays a maximize box on the dialog. - @style{wxMINIMIZE_BOX}: + @style{wxMINIMIZE_BOX} Displays a minimize box on the dialog. - @style{wxTHICK_FRAME}: + @style{wxTHICK_FRAME} Display a thick frame around the window. - @style{wxSTAY_ON_TOP}: + @style{wxSTAY_ON_TOP} The dialog stays on top of all other windows. - @style{wxNO_3D}: + @style{wxNO_3D} Under Windows, specifies that the child controls should not have 3D borders unless specified in the control. - @style{wxDIALOG_NO_PARENT}: + @style{wxDIALOG_NO_PARENT} By default, a dialog created with a @NULL parent window will be given the application's top level window as parent. Use this style to prevent this from happening and create an orphan dialog. This is not recommended for modal dialogs. - @style{wxDIALOG_EX_CONTEXTHELP}: + @style{wxDIALOG_EX_CONTEXTHELP} Under Windows, puts a query button on the caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send a wxEVT_HELP event if the user clicked on an application window. Note that this is an extended style and must be set by calling SetExtraStyle before Create is called (two-step construction). - @style{wxDIALOG_EX_METAL}: + @style{wxDIALOG_EX_METAL} On Mac OS X, frames with this style will be shown with a metallic look. This is an extra style. @endStyleTable diff --git a/interface/dirdlg.h b/interface/dirdlg.h index cb7b4eba1c..c6bd03c273 100644 --- a/interface/dirdlg.h +++ b/interface/dirdlg.h @@ -13,15 +13,15 @@ This class represents the directory chooser dialog. @beginStyleTable - @style{wxDD_DEFAULT_STYLE}: + @style{wxDD_DEFAULT_STYLE} Equivalent to a combination of wxDEFAULT_DIALOG_STYLE and wxRESIZE_BORDER (the last one is not used under wxWinCE). - @style{wxDD_DIR_MUST_EXIST}: + @style{wxDD_DIR_MUST_EXIST} The dialog will allow the user to choose only an existing folder. When this style is not given, a "Create new directory" button is added to the dialog (on Windows) or some other way is provided to the user to type the name of a new folder. - @style{wxDD_CHANGE_DIR}: + @style{wxDD_CHANGE_DIR} Change the current working directory to the directory chosen by the user. @endStyleTable diff --git a/interface/editlbox.h b/interface/editlbox.h index dfc74a4cd3..ae0dcb2c22 100644 --- a/interface/editlbox.h +++ b/interface/editlbox.h @@ -14,15 +14,15 @@ delete and reorder a list of strings. @beginStyleTable - @style{wxEL_ALLOW_NEW}: + @style{wxEL_ALLOW_NEW} Allows the user to enter new strings. - @style{wxEL_ALLOW_EDIT}: + @style{wxEL_ALLOW_EDIT} Allows the user to edit existing strings. - @style{wxEL_ALLOW_DELETE}: + @style{wxEL_ALLOW_DELETE} Allows the user to delete existing strings. - @style{wxEL_NO_REORDER}: + @style{wxEL_NO_REORDER} Does not allow the user to reorder the strings. - @style{wxEL_DEFAULT_STYLE}: + @style{wxEL_DEFAULT_STYLE} Default style: wxEL_ALLOW_NEW|wxEL_ALLOW_EDIT|wxEL_ALLOW_DELETE. @endStyleTable diff --git a/interface/event.h b/interface/event.h index ab0b2cad3b..08a2849d66 100644 --- a/interface/event.h +++ b/interface/event.h @@ -652,11 +652,11 @@ public: @beginEventTable{wxKeyEvent} - @event{EVT_KEY_DOWN(func)}: + @event{EVT_KEY_DOWN(func)} Process a wxEVT_KEY_DOWN event (any key has been pressed). - @event{EVT_KEY_UP(func)}: + @event{EVT_KEY_UP(func)} Process a wxEVT_KEY_UP event (any key has been released). - @event{EVT_CHAR(func)}: + @event{EVT_CHAR(func)} Process a wxEVT_CHAR event. @endEventTable @@ -818,15 +818,15 @@ public: events received by windows. @beginEventTable{wxJoystickEvent} - @style{EVT_JOY_BUTTON_DOWN(func)}: + @style{EVT_JOY_BUTTON_DOWN(func)} Process a wxEVT_JOY_BUTTON_DOWN event. - @style{EVT_JOY_BUTTON_UP(func)}: + @style{EVT_JOY_BUTTON_UP(func)} Process a wxEVT_JOY_BUTTON_UP event. - @style{EVT_JOY_MOVE(func)}: + @style{EVT_JOY_MOVE(func)} Process a wxEVT_JOY_MOVE event. - @style{EVT_JOY_ZMOVE(func)}: + @style{EVT_JOY_ZMOVE(func)} Process a wxEVT_JOY_ZMOVE event. - @style{EVT_JOYSTICK_EVENTS(func)}: + @style{EVT_JOYSTICK_EVENTS(func)} Processes all joystick events. @endEventTable @@ -933,24 +933,24 @@ public: @beginEventTable{wxScrollWinEvent} You can use the EVT_SCROLLWIN* macros for intercepting scroll window events from the receiving window. - @event{EVT_SCROLLWIN(func)}: + @event{EVT_SCROLLWIN(func)} Process all scroll events. - @event{EVT_SCROLLWIN_TOP(func)}: + @event{EVT_SCROLLWIN_TOP(func)} Process 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. - @event{EVT_SCROLLWIN_LINEUP(func)}: + @event{EVT_SCROLLWIN_LINEUP(func)} Process wxEVT_SCROLLWIN_LINEUP line up events. - @event{EVT_SCROLLWIN_LINEDOWN(func)}: + @event{EVT_SCROLLWIN_LINEDOWN(func)} Process wxEVT_SCROLLWIN_LINEDOWN line down events. - @event{EVT_SCROLLWIN_PAGEUP(func)}: + @event{EVT_SCROLLWIN_PAGEUP(func)} Process wxEVT_SCROLLWIN_PAGEUP page up events. - @event{EVT_SCROLLWIN_PAGEDOWN(func)}: + @event{EVT_SCROLLWIN_PAGEDOWN(func)} Process wxEVT_SCROLLWIN_PAGEDOWN page down events. - @event{EVT_SCROLLWIN_THUMBTRACK(func)}: + @event{EVT_SCROLLWIN_THUMBTRACK(func)} Process wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events (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. @endEventTable @@ -1003,7 +1003,7 @@ public: class handler, or to pass the event on to the window's children explicitly. @beginEventTable{wxSysColourChangedEvent} - @event{EVT_SYS_COLOUR_CHANGED(func)}: + @event{EVT_SYS_COLOUR_CHANGED(func)} Process a wxEVT_SYS_COLOUR_CHANGED event. @endEventTable @@ -1034,7 +1034,7 @@ public: the window hierarchy. @beginEventTable{wxWindowCreateEvent} - @event{EVT_WINDOW_CREATE(func)}: + @event{EVT_WINDOW_CREATE(func)} Process a wxEVT_CREATE event. @endEventTable @@ -1116,7 +1116,7 @@ public: @beginEventTable{wxPaintEvent} - @event{EVT_PAINT(func)}: + @event{EVT_PAINT(func)} Process a wxEVT_PAINT event. @endEventTable @@ -1145,7 +1145,7 @@ public: maximized, only a normal wxSizeEvent is generated in this case. @beginEventTable{wxMaximizeEvent} - @event{EVT_MAXIMIZE(func)}: + @event{EVT_MAXIMIZE(func)} Process a wxEVT_MAXIMIZE event. @endEventTable @@ -1225,9 +1225,9 @@ enum wxUpdateUIMode @beginEventTable{wxUpdateUIEvent} - @event{EVT_UPDATE_UI(id, func)}: + @event{EVT_UPDATE_UI(id, func)} Process a wxEVT_UPDATE_UI event for the command with the given id. - @event{EVT_UPDATE_UI_RANGE(id1, id2, func)}: + @event{EVT_UPDATE_UI_RANGE(id1, id2, func)} Process a wxEVT_UPDATE_UI event for any command with id included in the given range. @endEventTable @@ -1405,12 +1405,12 @@ public: They are generated by all controls under Windows. @beginEventTable{wxClipboardTextEvent} - @event{EVT_TEXT_COPY(id, func)}: + @event{EVT_TEXT_COPY(id, func)} Some or all of the controls content was copied to the clipboard. - @event{EVT_TEXT_CUT(id, func)}: + @event{EVT_TEXT_CUT(id, func)} Some or all of the controls content was cut (i.e. copied and deleted). - @event{EVT_TEXT_PASTE(id, func)}: + @event{EVT_TEXT_PASTE(id, func)} Clipboard content was pasted into the control. @endEventTable @@ -1470,47 +1470,47 @@ public: @beginEventTable{wxMouseEvent} - @event{EVT_LEFT_DOWN(func)}: + @event{EVT_LEFT_DOWN(func)} Process a wxEVT_LEFT_DOWN event. The handler of this event should normally call event.Skip() to allow the default processing to take place as otherwise the window under mouse wouldn't get the focus. - @event{EVT_LEFT_UP(func)}: + @event{EVT_LEFT_UP(func)} Process a wxEVT_LEFT_UP event. - @event{EVT_LEFT_DCLICK(func)}: + @event{EVT_LEFT_DCLICK(func)} Process a wxEVT_LEFT_DCLICK event. - @event{EVT_MIDDLE_DOWN(func)}: + @event{EVT_MIDDLE_DOWN(func)} Process a wxEVT_MIDDLE_DOWN event. - @event{EVT_MIDDLE_UP(func)}: + @event{EVT_MIDDLE_UP(func)} Process a wxEVT_MIDDLE_UP event. - @event{EVT_MIDDLE_DCLICK(func)}: + @event{EVT_MIDDLE_DCLICK(func)} Process a wxEVT_MIDDLE_DCLICK event. - @event{EVT_RIGHT_DOWN(func)}: + @event{EVT_RIGHT_DOWN(func)} Process a wxEVT_RIGHT_DOWN event. - @event{EVT_RIGHT_UP(func)}: + @event{EVT_RIGHT_UP(func)} Process a wxEVT_RIGHT_UP event. - @event{EVT_RIGHT_DCLICK(func)}: + @event{EVT_RIGHT_DCLICK(func)} Process a wxEVT_RIGHT_DCLICK event. - @event{EVT_MOUSE_AUX1_DOWN(func)}: + @event{EVT_MOUSE_AUX1_DOWN(func)} Process a wxEVT_MOUSE_AUX1_DOWN event. - @event{EVT_MOUSE_AUX1_UP(func)}: + @event{EVT_MOUSE_AUX1_UP(func)} Process a wxEVT_MOUSE_AUX1_UP event. - @event{EVT_MOUSE_AUX1_DCLICK(func)}: + @event{EVT_MOUSE_AUX1_DCLICK(func)} Process a wxEVT_MOUSE_AUX1_DCLICK event. - @event{EVT_MOUSE_AUX2_DOWN(func)}: + @event{EVT_MOUSE_AUX2_DOWN(func)} Process a wxEVT_MOUSE_AUX2_DOWN event. - @event{EVT_MOUSE_AUX2_UP(func)}: + @event{EVT_MOUSE_AUX2_UP(func)} Process a wxEVT_MOUSE_AUX2_UP event. - @event{EVT_MOUSE_AUX2_DCLICK(func)}: + @event{EVT_MOUSE_AUX2_DCLICK(func)} Process a wxEVT_MOUSE_AUX2_DCLICK event. - @event{EVT_MOTION(func)}: + @event{EVT_MOTION(func)} Process a wxEVT_MOTION event. - @event{EVT_ENTER_WINDOW(func)}: + @event{EVT_ENTER_WINDOW(func)} Process a wxEVT_ENTER_WINDOW event. - @event{EVT_LEAVE_WINDOW(func)}: + @event{EVT_LEAVE_WINDOW(func)} Process a wxEVT_LEAVE_WINDOW event. - @event{EVT_MOUSEWHEEL(func)}: + @event{EVT_MOUSEWHEEL(func)} Process a wxEVT_MOUSEWHEEL event. - @event{EVT_MOUSE_EVENTS(func)}: + @event{EVT_MOUSE_EVENTS(func)} Process all mouse events. @endEventTable @@ -1860,7 +1860,7 @@ public: message-based approach of dropping files. @beginEventTable{wxDropFilesEvent} - @event{EVT_DROP_FILES(func)}: + @event{EVT_DROP_FILES(func)} Process a wxEVT_DROP_FILES event. @endEventTable @@ -1909,77 +1909,77 @@ public: More complex controls, such as wxTreeCtrl, have separate command event classes. @beginEventTable{wxCommandEvent} - @event{EVT_COMMAND(id, event, func)}: + @event{EVT_COMMAND(id, event, func)} Process a command, supplying the window identifier, command event identifier, and member function. - @event{EVT_COMMAND_RANGE(id1, id2, event, func)}: + @event{EVT_COMMAND_RANGE(id1, id2, event, func)} Process a command for a range of window identifiers, supplying the minimum and maximum window identifiers, command event identifier, and member function. - @event{EVT_BUTTON(id, func)}: + @event{EVT_BUTTON(id, func)} Process a wxEVT_COMMAND_BUTTON_CLICKED command, which is generated by a wxButton control. - @event{EVT_CHECKBOX(id, func)}: + @event{EVT_CHECKBOX(id, func)} Process a wxEVT_COMMAND_CHECKBOX_CLICKED command, which is generated by a wxCheckBox control. - @event{EVT_CHOICE(id, func)}: + @event{EVT_CHOICE(id, func)} Process a wxEVT_COMMAND_CHOICE_SELECTED command, which is generated by a wxChoice control. - @event{EVT_COMBOBOX(id, func)}: + @event{EVT_COMBOBOX(id, func)} Process a wxEVT_COMMAND_COMBOBOX_SELECTED command, which is generated by a wxComboBox control. - @event{EVT_LISTBOX(id, func)}: + @event{EVT_LISTBOX(id, func)} Process a wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wxListBox control. - @event{EVT_LISTBOX_DCLICK(id, func)}: + @event{EVT_LISTBOX_DCLICK(id, func)} Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wxListBox control. - @event{EVT_MENU(id, func)}: + @event{EVT_MENU(id, func)} Process a wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item. - @event{EVT_MENU_RANGE(id1, id2, func)}: + @event{EVT_MENU_RANGE(id1, id2, func)} Process a wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items. - @event{EVT_CONTEXT_MENU(func)}: + @event{EVT_CONTEXT_MENU(func)} Process the event generated when the user has requested a popup menu to appear by pressing a special keyboard key (under Windows) or by right clicking the mouse. - @event{EVT_RADIOBOX(id, func)}: + @event{EVT_RADIOBOX(id, func)} Process a wxEVT_COMMAND_RADIOBOX_SELECTED command, which is generated by a wxRadioBox control. - @event{EVT_RADIOBUTTON(id, func)}: + @event{EVT_RADIOBUTTON(id, func)} Process a wxEVT_COMMAND_RADIOBUTTON_SELECTED command, which is generated by a wxRadioButton control. - @event{EVT_SCROLLBAR(id, func)}: + @event{EVT_SCROLLBAR(id, func)} Process a wxEVT_COMMAND_SCROLLBAR_UPDATED command, which is generated by a wxScrollBar control. This is provided for compatibility only; more specific scrollbar event macros should be used instead (see wxScrollEvent). - @event{EVT_SLIDER(id, func)}: + @event{EVT_SLIDER(id, func)} Process a wxEVT_COMMAND_SLIDER_UPDATED command, which is generated by a wxSlider control. - @event{EVT_TEXT(id, func)}: + @event{EVT_TEXT(id, func)} Process a wxEVT_COMMAND_TEXT_UPDATED command, which is generated by a wxTextCtrl control. - @event{EVT_TEXT_ENTER(id, func)}: + @event{EVT_TEXT_ENTER(id, func)} Process a wxEVT_COMMAND_TEXT_ENTER command, which is generated by a wxTextCtrl control. Note that you must use wxTE_PROCESS_ENTER flag when creating the control if you want it to generate such events. - @event{EVT_TEXT_MAXLEN(id, func)}: + @event{EVT_TEXT_MAXLEN(id, func)} Process a wxEVT_COMMAND_TEXT_MAXLEN command, which is generated by a wxTextCtrl control when the user tries to enter more characters into it than the limit previously set with SetMaxLength(). - @event{EVT_TOGGLEBUTTON(id, func)}: + @event{EVT_TOGGLEBUTTON(id, func)} Process a wxEVT_COMMAND_TOGGLEBUTTON_CLICKED event. - @event{EVT_TOOL(id, func)}: + @event{EVT_TOOL(id, func)} Process a wxEVT_COMMAND_TOOL_CLICKED event (a synonym for wxEVT_COMMAND_MENU_SELECTED). Pass the id of the tool. - @event{EVT_TOOL_RANGE(id1, id2, func)}: + @event{EVT_TOOL_RANGE(id1, id2, func)} Process a wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools. - @event{EVT_TOOL_RCLICKED(id, func)}: + @event{EVT_TOOL_RCLICKED(id, func)} Process a wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool. - @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)}: + @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)} Process a wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools. - @event{EVT_TOOL_ENTER(id, func)}: + @event{EVT_TOOL_ENTER(id, func)} Process a wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself. The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor has moved off a tool. - @event{EVT_COMMAND_LEFT_CLICK(id, func)}: + @event{EVT_COMMAND_LEFT_CLICK(id, func)} Process a wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (Windows 95 and NT only). - @event{EVT_COMMAND_LEFT_DCLICK(id, func)}: + @event{EVT_COMMAND_LEFT_DCLICK(id, func)} Process a wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (Windows 95 and NT only). - @event{EVT_COMMAND_RIGHT_CLICK(id, func)}: + @event{EVT_COMMAND_RIGHT_CLICK(id, func)} Process a wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (Windows 95 and NT only). - @event{EVT_COMMAND_SET_FOCUS(id, func)}: + @event{EVT_COMMAND_SET_FOCUS(id, func)} Process a wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (Windows 95 and NT only). - @event{EVT_COMMAND_KILL_FOCUS(id, func)}: + @event{EVT_COMMAND_KILL_FOCUS(id, func)} Process a wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (Windows 95 and NT only). - @event{EVT_COMMAND_ENTER(id, func)}: + @event{EVT_COMMAND_ENTER(id, func)} Process a wxEVT_COMMAND_ENTER command, which is generated by a control. @endEventTable @@ -2092,11 +2092,11 @@ public: or deactivated. @beginEventTable{wxActivateEvent} - @event{EVT_ACTIVATE(func)}: + @event{EVT_ACTIVATE(func)} Process a wxEVT_ACTIVATE event. - @event{EVT_ACTIVATE_APP(func)}: + @event{EVT_ACTIVATE_APP(func)} Process a wxEVT_ACTIVATE_APP event. - @event{EVT_HIBERNATE(func)}: + @event{EVT_HIBERNATE(func)} Process a hibernate event, supplying the member function. This event applies to wxApp only, and only on Windows SmartPhone and PocketPC. It is generated when the system is low on memory; the application should free @@ -2145,7 +2145,7 @@ public: for mouse right-down events. @beginEventTable{wxContextMenuEvent} - @event{EVT_CONTEXT_MENU(func)}: + @event{EVT_CONTEXT_MENU(func)} A right click (or other context menu command depending on platform) has been detected. @endEventTable @@ -2206,7 +2206,7 @@ public: a wxPaintDC in the event handler. @beginEventTable{wxEraseEvent} - @event{EVT_ERASE_BACKGROUND(func)}: + @event{EVT_ERASE_BACKGROUND(func)} Process a wxEVT_ERASE_BACKGROUND event. @endEventTable @@ -2243,9 +2243,9 @@ public: program itself using wxWindow::SetFocus. @beginEventTable{wxFocusEvent} - @event{EVT_SET_FOCUS(func)}: + @event{EVT_SET_FOCUS(func)} Process a wxEVT_SET_FOCUS event. - @event{EVT_KILL_FOCUS(func)}: + @event{EVT_KILL_FOCUS(func)} Process a wxEVT_KILL_FOCUS event. @endEventTable @@ -2286,7 +2286,7 @@ public: Use wxWindow::FindFocus() to retreive the window which is actually getting focus. @beginEventTable{wxChildFocusEvent} - @event{EVT_CHILD_FOCUS(func)}: + @event{EVT_CHILD_FOCUS(func)} Process a wxEVT_CHILD_FOCUS event. @endEventTable @@ -2334,7 +2334,7 @@ public: This event is currently emitted under Windows only. @beginEventTable{wxMouseCaptureLostEvent} - @event{EVT_MOUSE_CAPTURE_LOST(func)}: + @event{EVT_MOUSE_CAPTURE_LOST(func)} Process a wxEVT_MOUSE_CAPTURE_LOST event. @endEventTable @@ -2444,9 +2444,9 @@ enum wxHelpEventOrigin found. @beginEventTable{wxHelpEvent} - @event{EVT_HELP(id, func)}: + @event{EVT_HELP(id, func)} Process a wxEVT_HELP event. - @event{EVT_HELP_RANGE(id1, id2, func)}: + @event{EVT_HELP_RANGE(id1, id2, func)} Process a wxEVT_HELP event for a range of ids. @endEventTable @@ -2534,47 +2534,47 @@ public: scroll events from controls, or EVT_SCROLL... macros without window IDs for intercepting scroll events from the receiving window -- except for this, the macros behave exactly the same. - @event{EVT_SCROLL(func)}: + @event{EVT_SCROLL(func)} Process all scroll events. - @event{EVT_SCROLL_TOP(func)}: + @event{EVT_SCROLL_TOP(func)} Process 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). - @event{EVT_SCROLL_LINEUP(func)}: + @event{EVT_SCROLL_LINEUP(func)} Process wxEVT_SCROLL_LINEUP line up events. - @event{EVT_SCROLL_LINEDOWN(func)}: + @event{EVT_SCROLL_LINEDOWN(func)} Process wxEVT_SCROLL_LINEDOWN line down events. - @event{EVT_SCROLL_PAGEUP(func)}: + @event{EVT_SCROLL_PAGEUP(func)} Process wxEVT_SCROLL_PAGEUP page up events. - @event{EVT_SCROLL_PAGEDOWN(func)}: + @event{EVT_SCROLL_PAGEDOWN(func)} Process 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 user drags the thumbtrack). - @event{EVT_SCROLL_THUMBRELEASE(func)}: + @event{EVT_SCROLL_THUMBRELEASE(func)} Process 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). - @event{EVT_COMMAND_SCROLL(id, func)}: + @event{EVT_COMMAND_SCROLL(id, func)} 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). - @event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}: + @event{EVT_COMMAND_SCROLL_BOTTOM(id, func)} Process 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. - @event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}: + @event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)} Process 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. - @event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}: + @event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)} Process 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 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. - @event{EVT_COMMAND_SCROLL_CHANGED(func)}: + @event{EVT_COMMAND_SCROLL_CHANGED(func)} Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only). @endEventTable @@ -2640,7 +2640,7 @@ enum wxIdleMode idle events. @beginEventTable{wxIdleEvent} - @event{EVT_IDLE(func)}: + @event{EVT_IDLE(func)} Process a wxEVT_IDLE event. @endEventTable @@ -2727,7 +2727,7 @@ public: The default handler calls wxWindow::TransferDataToWindow. @beginEventTable{wxInitDialogEvent} - @event{EVT_INIT_DIALOG(func)}: + @event{EVT_INIT_DIALOG(func)} Process a wxEVT_INIT_DIALOG event. @endEventTable @@ -2803,7 +2803,7 @@ enum wxNavigationKeyEventFlags WX_DECLARE_CONTROL_CONTAINER. @beginEventTable{wxNavigationKeyEvent} - @event{EVT_NAVIGATION_KEY(func)}: + @event{EVT_NAVIGATION_KEY(func)} Process a navigation key event. @endEventTable @@ -2883,7 +2883,7 @@ public: @onlyfor{wxmsw} @beginEventTable{wxMouseCaptureChangedEvent} - @event{EVT_MOUSE_CAPTURE_CHANGED(func)}: + @event{EVT_MOUSE_CAPTURE_CHANGED(func)} Process a wxEVT_MOUSE_CAPTURE_CHANGED event. @endEventTable @@ -2935,13 +2935,13 @@ public: on whether the close instruction was honoured or not. @beginEventTable{wxCloseEvent} - @event{EVT_CLOSE(func)}: + @event{EVT_CLOSE(func)} Process a close event, supplying the member function. This event applies to wxFrame and wxDialog classes. - @event{EVT_QUERY_END_SESSION(func)}: + @event{EVT_QUERY_END_SESSION(func)} Process a query end session event, supplying the member function. This event applies to wxApp only. - @event{EVT_END_SESSION(func)}: + @event{EVT_END_SESSION(func)} Process an end session event, supplying the member function. This event applies to wxApp only. @endEventTable @@ -3011,15 +3011,15 @@ public: text in the first field of the status bar. @beginEventTable{wxMenuEvent} - @event{EVT_MENU_OPEN(func)}: + @event{EVT_MENU_OPEN(func)} A menu is about to be opened. On Windows, this is only sent once for each navigation of the menubar (up until all menus have closed). - @event{EVT_MENU_CLOSE(func)}: + @event{EVT_MENU_CLOSE(func)} A menu has been just closed. - @event{EVT_MENU_HIGHLIGHT(id, func)}: + @event{EVT_MENU_HIGHLIGHT(id, func)} The menu item with the specified id has been highlighted: used to show help prompts in the status bar by wxFrame - @event{EVT_MENU_HIGHLIGHT_ALL(func)}: + @event{EVT_MENU_HIGHLIGHT_ALL(func)} A menu item has been highlighted, i.e. the currently selected menu item has changed. @endEventTable @@ -3070,7 +3070,7 @@ public: @onlyfor{wxmsw,wxgtk} @beginEventTable{wxIconizeEvent} - @event{EVT_ICONIZE(func)}: + @event{EVT_ICONIZE(func)} Process a wxEVT_ICONIZE event. @endEventTable @@ -3104,12 +3104,12 @@ public: A move event holds information about move change events. @beginEventTable{wxMoveEvent} - @event{EVT_MOVE(func)}: + @event{EVT_MOVE(func)} Process a wxEVT_MOVE event, which is generated when a window is moved. - @event{EVT_MOVE_START(func)}: + @event{EVT_MOVE_START(func)} Process a wxEVT_MOVE_START event, which is generated when the user starts to move or size a window. wxMSW only. - @event{EVT_MOVE_END(func)}: + @event{EVT_MOVE_END(func)} Process a wxEVT_MOVE_END event, which is generated when the user stops moving or sizing a window. wxMSW only. @endEventTable @@ -3153,7 +3153,7 @@ public: In which case, you may need to call wxWindow::Refresh to invalidate the entire window. @beginEventTable{wxSizeEvent} - @event{EVT_SIZE(func)}: + @event{EVT_SIZE(func)} Process a wxEVT_SIZE event. @endEventTable @@ -3190,7 +3190,7 @@ public: Use wxSetCursorEvent::SetCursor to specify the cursor you want to be displayed. @beginEventTable{wxSetCursorEvent} - @event{EVT_SET_CURSOR(func)}: + @event{EVT_SET_CURSOR(func)} Process a wxEVT_SET_CURSOR event. @endEventTable diff --git a/interface/fdrepdlg.h b/interface/fdrepdlg.h index 7696f782dc..e704d00c4e 100644 --- a/interface/fdrepdlg.h +++ b/interface/fdrepdlg.h @@ -49,15 +49,15 @@ enum wxFindReplaceDialogStyles wxFindReplaceDialog events @beginEventTable{wxFindDialogEvent} - @event{EVT_FIND(id, func)}: + @event{EVT_FIND(id, func)} Find button was pressed in the dialog. - @event{EVT_FIND_NEXT(id, func)}: + @event{EVT_FIND_NEXT(id, func)} Find next button was pressed in the dialog. - @event{EVT_FIND_REPLACE(id, func)}: + @event{EVT_FIND_REPLACE(id, func)} Replace button was pressed in the dialog. - @event{EVT_FIND_REPLACE_ALL(id, func)}: + @event{EVT_FIND_REPLACE_ALL(id, func)} Replace all button was pressed in the dialog. - @event{EVT_FIND_CLOSE(id, func)}: + @event{EVT_FIND_CLOSE(id, func)} The dialog is being destroyed, any pointers to it cannot be used any longer. @endEventTable diff --git a/interface/filectrl.h b/interface/filectrl.h index 3c8d2a3a5b..ff54bb3bef 100644 --- a/interface/filectrl.h +++ b/interface/filectrl.h @@ -16,28 +16,28 @@ other than Gtk. It is only available if @c wxUSE_FILECTRL is set to 1. @beginStyleTable - @style{wxFC_DEFAULT_STYLE}: + @style{wxFC_DEFAULT_STYLE} The default style: wxFC_OPEN - @style{wxFC_OPEN}: + @style{wxFC_OPEN} Creates an file control suitable for opening files. Cannot be combined with wxFC_SAVE. - @style{wxFC_SAVE}: + @style{wxFC_SAVE} Creates an file control suitable for saving files. Cannot be combined with wxFC_OPEN. - @style{wxFC_MULTIPLE}: + @style{wxFC_MULTIPLE} For open control only, Allows selecting multiple files. Cannot be combined with wxFC_SAVE - @style{wxFC_NOSHOWHIDDEN}: + @style{wxFC_NOSHOWHIDDEN} Hides the "Show Hidden Files" checkbox (Generic only) @endStyleTable @beginEventTable{wxFileCtrlEvent} - @event{EVT_FILECTRL_FILEACTIVATED(id, func)}: + @event{EVT_FILECTRL_FILEACTIVATED(id, func)} The user activated a file(by double-clicking or pressing Enter) - @event{EVT_FILECTRL_SELECTIONCHANGED(id, func)}: + @event{EVT_FILECTRL_SELECTIONCHANGED(id, func)} The user changed the current selection(by selecting or deselecting a file) - @event{EVT_FILECTRL_FOLDERCHANGED(id, func)}: + @event{EVT_FILECTRL_FOLDERCHANGED(id, func)} The current folder of the file control has been changed @endEventTable @@ -192,11 +192,11 @@ public: wxFileCtrl objects. @beginEventTable{wxFileCtrlEvent} - @event{EVT_FILECTRL_FILEACTIVATED(id, func)}: + @event{EVT_FILECTRL_FILEACTIVATED(id, func)} The user activated a file(by double-clicking or pressing Enter) - @event{EVT_FILECTRL_SELECTIONCHANGED(id, func)}: + @event{EVT_FILECTRL_SELECTIONCHANGED(id, func)} The user changed the current selection(by selecting or deselecting a file) - @event{EVT_FILECTRL_FOLDERCHANGED(id, func)}: + @event{EVT_FILECTRL_FOLDERCHANGED(id, func)} The current folder of the file control has been changed @endEventTable diff --git a/interface/filedlg.h b/interface/filedlg.h index e4e64c3724..ada7bba196 100644 --- a/interface/filedlg.h +++ b/interface/filedlg.h @@ -33,25 +33,25 @@ are errors. @beginStyleTable - @style{wxFD_DEFAULT_STYLE}: + @style{wxFD_DEFAULT_STYLE} Equivalent to wxFD_OPEN. - @style{wxFD_OPEN}: + @style{wxFD_OPEN} This is an open dialog; usually this means that the default button's label of the dialog is "Open". Cannot be combined with wxFD_SAVE. - @style{wxFD_SAVE}: + @style{wxFD_SAVE} This is a save dialog; usually this means that the default button's label of the dialog is "Save". Cannot be combined with wxFD_OPEN. - @style{wxFD_OVERWRITE_PROMPT}: + @style{wxFD_OVERWRITE_PROMPT} For save dialog only: prompt for a confirmation if a file will be overwritten. - @style{wxFD_FILE_MUST_EXIST}: + @style{wxFD_FILE_MUST_EXIST} For open dialog only: the user may only select files that actually exist. - @style{wxFD_MULTIPLE}: + @style{wxFD_MULTIPLE} For open dialog only: allows selecting multiple files. - @style{wxFD_CHANGE_DIR}: + @style{wxFD_CHANGE_DIR} Change the current working directory to the directory where the file(s) chosen by the user are. - @style{wxFD_PREVIEW}: + @style{wxFD_PREVIEW} Show the preview of the selected files (currently only supported by wxGTK using GTK+ 2.4 or later). @endStyleTable diff --git a/interface/filepicker.h b/interface/filepicker.h index 2a2d610fc6..2c9e5bdbfc 100644 --- a/interface/filepicker.h +++ b/interface/filepicker.h @@ -18,26 +18,26 @@ It is only available if @c wxUSE_FILEPICKERCTRL is set to 1 (the default). @beginStyleTable - @style{wxFLP_DEFAULT_STYLE}: + @style{wxFLP_DEFAULT_STYLE} The default style: includes wxFLP_OPEN | wxFLP_FILE_MUST_EXIST and, under wxMSW only, wxFLP_USE_TEXTCTRL. - @style{wxFLP_USE_TEXTCTRL}: + @style{wxFLP_USE_TEXTCTRL} Creates a text control to the left of the picker button which is completely managed by the wxFilePickerCtrl and which can be used by the user to specify a path (see SetPath). The text control is automatically synchronized with button's value. Use functions defined in wxPickerBase to modify the text control. - @style{wxFLP_OPEN}: + @style{wxFLP_OPEN} Creates a picker which allows the user to select a file to open. - @style{wxFLP_SAVE}: + @style{wxFLP_SAVE} Creates a picker which allows the user to select a file to save. - @style{wxFLP_OVERWRITE_PROMPT}: + @style{wxFLP_OVERWRITE_PROMPT} Can be combined with wxFLP_SAVE only: ask confirmation to the user before selecting a file. - @style{wxFLP_FILE_MUST_EXIST}: + @style{wxFLP_FILE_MUST_EXIST} Can be combined with wxFLP_OPEN only: the selected file must be an existing file. - @style{wxFLP_CHANGE_DIR}: + @style{wxFLP_CHANGE_DIR} Change current working directory on each user file selection change. @endStyleTable @@ -141,20 +141,20 @@ public: It is only available if @c wxUSE_DIRPICKERCTRL is set to 1 (the default). @beginStyleTable - @style{wxDIRP_DEFAULT_STYLE}: + @style{wxDIRP_DEFAULT_STYLE} The default style: includes wxDIRP_DIR_MUST_EXIST and, under wxMSW only, wxDIRP_USE_TEXTCTRL. - @style{wxDIRP_USE_TEXTCTRL}: + @style{wxDIRP_USE_TEXTCTRL} Creates a text control to the left of the picker button which is completely managed by the wxDirPickerCtrl and which can be used by the user to specify a path (see SetPath). The text control is automatically synchronized with button's value. Use functions defined in wxPickerBase to modify the text control. - @style{wxDIRP_DIR_MUST_EXIST}: + @style{wxDIRP_DIR_MUST_EXIST} Creates a picker which allows to select only existing directories. wxGTK control always adds this flag internally as it does not support its absence. - @style{wxDIRP_CHANGE_DIR}: + @style{wxDIRP_CHANGE_DIR} Change current working directory on each user directory selection change. @endStyleTable diff --git a/interface/fontpicker.h b/interface/fontpicker.h index 170f42c558..a616a86c49 100644 --- a/interface/fontpicker.h +++ b/interface/fontpicker.h @@ -18,21 +18,21 @@ It is only available if @c wxUSE_FONTPICKERCTRL is set to 1 (the default). @beginStyleTable - @style{wxFNTP_DEFAULT_STYLE}: + @style{wxFNTP_DEFAULT_STYLE} The default style: wxFNTP_FONTDESC_AS_LABEL | wxFNTP_USEFONT_FOR_LABEL. - @style{wxFNTP_USE_TEXTCTRL}: + @style{wxFNTP_USE_TEXTCTRL} Creates a text control to the left of the picker button which is completely managed by the wxFontPickerCtrl and which can be used by the user to specify a font (see SetSelectedFont). The text control is automatically synchronized with button's value. Use functions defined in wxPickerBase to modify the text control. - @style{wxFNTP_FONTDESC_AS_LABEL}: + @style{wxFNTP_FONTDESC_AS_LABEL} Keeps the label of the button updated with the fontface name and the font size. E.g. choosing "Times New Roman bold, italic with size 10" from the fontdialog, will update the label (overwriting any previous label) with the "Times New Roman, 10" text. - @style{wxFNTP_USEFONT_FOR_LABEL}: + @style{wxFNTP_USEFONT_FOR_LABEL} Uses the currently selected font to draw the label of the button. @endStyleTable diff --git a/interface/frame.h b/interface/frame.h index 8f979b90ee..14b0e1d28d 100644 --- a/interface/frame.h +++ b/interface/frame.h @@ -21,33 +21,33 @@ application windows. @beginStyleTable - @style{wxDEFAULT_FRAME_STYLE}: + @style{wxDEFAULT_FRAME_STYLE} Defined as wxMINIMIZE_BOX | wxMAXIMIZE_BOX | wxRESIZE_BORDER | wxSYSTEM_MENU | wxCAPTION | wxCLOSE_BOX | wxCLIP_CHILDREN. - @style{wxICONIZE}: + @style{wxICONIZE} Display the frame iconized (minimized). Windows only. - @style{wxCAPTION}: + @style{wxCAPTION} Puts a caption on the frame. - @style{wxMINIMIZE}: + @style{wxMINIMIZE} Identical to wxICONIZE. Windows only. - @style{wxMINIMIZE_BOX}: + @style{wxMINIMIZE_BOX} Displays a minimize box on the frame. - @style{wxMAXIMIZE}: + @style{wxMAXIMIZE} Displays the frame maximized. Windows only. - @style{wxMAXIMIZE_BOX}: + @style{wxMAXIMIZE_BOX} Displays a maximize box on the frame. - @style{wxCLOSE_BOX}: + @style{wxCLOSE_BOX} Displays a close box on the frame. - @style{wxSTAY_ON_TOP}: + @style{wxSTAY_ON_TOP} Stay on top of all other windows, see also wxFRAME_FLOAT_ON_PARENT. - @style{wxSYSTEM_MENU}: + @style{wxSYSTEM_MENU} Displays a system menu. - @style{wxRESIZE_BORDER}: + @style{wxRESIZE_BORDER} Displays a resizeable border around the window. - @style{wxFRAME_TOOL_WINDOW}: + @style{wxFRAME_TOOL_WINDOW} Causes a frame with a small titlebar to be created; the frame does not appear in the taskbar under Windows or GTK+. - @style{wxFRAME_NO_TASKBAR}: + @style{wxFRAME_NO_TASKBAR} Creates an otherwise normal frame but it does not appear in the taskbar under Windows or GTK+ (note that it will minimize to the desktop window under Windows which may seem strange to the users @@ -56,11 +56,11 @@ is at least version 2.2 and the window manager supports _NET_WM_STATE_SKIP_TASKBAR hint. Has no effect under other platforms. - @style{wxFRAME_FLOAT_ON_PARENT}: + @style{wxFRAME_FLOAT_ON_PARENT} The frame will always be on top of its parent (unlike wxSTAY_ON_TOP). A frame created with this style must have a non-@NULL parent. - @style{wxFRAME_EX_CONTEXTHELP}: + @style{wxFRAME_EX_CONTEXTHELP} Under Windows, puts a query button on the caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send a wxEVT_HELP event if the user clicked on an application @@ -71,10 +71,10 @@ wxDEFAULT_FRAME_STYLE ~ (wxMINIMIZE_BOX | wxMAXIMIZE_BOX) for the frames having this style (the dialogs don't have a minimize or a maximize box by default) - @style{wxFRAME_SHAPED}: + @style{wxFRAME_SHAPED} Windows with this style are allowed to have their shape changed with the SetShape method. - @style{wxFRAME_EX_METAL}: + @style{wxFRAME_EX_METAL} On Mac OS X, frames with this style will be shown with a metallic look. This is an extra style. @endStyleTable diff --git a/interface/gauge.h b/interface/gauge.h index 94bda71bfe..9585cba4ad 100644 --- a/interface/gauge.h +++ b/interface/gauge.h @@ -27,11 +27,11 @@ There are no user commands for the gauge. @beginStyleTable - @style{wxGA_HORIZONTAL}: + @style{wxGA_HORIZONTAL} Creates a horizontal gauge. - @style{wxGA_VERTICAL}: + @style{wxGA_VERTICAL} Creates a vertical gauge. - @style{wxGA_SMOOTH}: + @style{wxGA_SMOOTH} Creates smooth progress bar with one pixel wide update step (not supported by all platforms). @endStyleTable diff --git a/interface/html/htmlwin.h b/interface/html/htmlwin.h index 5481b9570c..fd3e514d70 100644 --- a/interface/html/htmlwin.h +++ b/interface/html/htmlwin.h @@ -24,12 +24,12 @@ wxHtmlWindow::LoadFile. @beginStyleTable - @style{wxHW_SCROLLBAR_NEVER}: + @style{wxHW_SCROLLBAR_NEVER} Never display scrollbars, not even when the page is larger than the window. - @style{wxHW_SCROLLBAR_AUTO}: + @style{wxHW_SCROLLBAR_AUTO} Display scrollbars only if page's size exceeds window's size. - @style{wxHW_NO_SELECTION}: + @style{wxHW_NO_SELECTION} Don't allow the user to select text. @endStyleTable diff --git a/interface/htmllbox.h b/interface/htmllbox.h index bac286253c..8b487f1ec5 100644 --- a/interface/htmllbox.h +++ b/interface/htmllbox.h @@ -168,9 +168,9 @@ public: or @c body tags. @beginStyleTable - @style{wxHLB_DEFAULT_STYLE}: + @style{wxHLB_DEFAULT_STYLE} The default style: wxBORDER_SUNKEN - @style{wxHLB_MULTIPLE}: + @style{wxHLB_MULTIPLE} Multiple-selection list: the user can toggle multiple items on and off. @endStyleTable diff --git a/interface/hyperlink.h b/interface/hyperlink.h index 8dc59863ac..2f77a1f339 100644 --- a/interface/hyperlink.h +++ b/interface/hyperlink.h @@ -54,18 +54,18 @@ public: wxWindow::SetFont, wxWindow::SetCursor, wxWindow::SetLabel can be used to customize appearance of the hyperlink. @beginStyleTable - @style{wxHL_ALIGN_LEFT}: + @style{wxHL_ALIGN_LEFT} Align the text to the left. - @style{wxHL_ALIGN_RIGHT}: + @style{wxHL_ALIGN_RIGHT} Align the text to the right. - @style{wxHL_ALIGN_CENTRE}: + @style{wxHL_ALIGN_CENTRE} Center the text (horizontally). - @style{wxHL_CONTEXTMENU}: + @style{wxHL_CONTEXTMENU} Pop up a context menu when the hyperlink is right-clicked. The context menu contains a "Copy URL" menu item which is automatically handled by the hyperlink and which just copies in the clipboard the URL (not the label) of the control. - @style{wxHL_DEFAULT_STYLE}: + @style{wxHL_DEFAULT_STYLE} The default style for wxHyperlinkCtrl: wxBORDER_NONE|wxHL_CONTEXTMENU|wxHL_ALIGN_CENTRE. @endStyleTable diff --git a/interface/listbook.h b/interface/listbook.h index f0e7245365..55d9427045 100644 --- a/interface/listbook.h +++ b/interface/listbook.h @@ -21,16 +21,16 @@ action. @beginStyleTable - @style{wxLB_DEFAULT}: + @style{wxLB_DEFAULT} Choose the default location for the labels depending on the current platform (left everywhere except Mac where it is top). - @style{wxLB_TOP}: + @style{wxLB_TOP} Place labels above the page area. - @style{wxLB_LEFT}: + @style{wxLB_LEFT} Place labels on the left side. - @style{wxLB_RIGHT}: + @style{wxLB_RIGHT} Place labels on the right side. - @style{wxLB_BOTTOM}: + @style{wxLB_BOTTOM} Place labels below the page area. @endStyleTable diff --git a/interface/listbox.h b/interface/listbox.h index 73ea54d0d4..6c83521644 100644 --- a/interface/listbox.h +++ b/interface/listbox.h @@ -25,29 +25,29 @@ wxEVT_COMMAND_LISTBOX_DOUBLECLICKED for double clicks. @beginStyleTable - @style{wxLB_SINGLE}: + @style{wxLB_SINGLE} Single-selection list. - @style{wxLB_MULTIPLE}: + @style{wxLB_MULTIPLE} Multiple-selection list: the user can toggle multiple items on and off. - @style{wxLB_EXTENDED}: + @style{wxLB_EXTENDED} Extended-selection list: the user can select multiple items using the SHIFT key and the mouse or special key combinations. - @style{wxLB_HSCROLL}: + @style{wxLB_HSCROLL} Create horizontal scrollbar if contents are too wide (Windows only). - @style{wxLB_ALWAYS_SB}: + @style{wxLB_ALWAYS_SB} Always show a vertical scrollbar. - @style{wxLB_NEEDED_SB}: + @style{wxLB_NEEDED_SB} Only create a vertical scrollbar if needed. - @style{wxLB_SORT}: + @style{wxLB_SORT} The listbox contents are sorted in alphabetical order. @endStyleTable @beginEventTable{wxCommandEvent} - @event{EVT_LISTBOX(id, func)}: + @event{EVT_LISTBOX(id, func)} Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the list is selected or the selection changes. - @event{EVT_LISTBOX_DCLICK(id, func)}: + @event{EVT_LISTBOX_DCLICK(id, func)} Process a wxEVT_COMMAND_LISTBOXDOUBLECLICKED event, when the listbox is double-clicked. @endEventTable diff --git a/interface/listctrl.h b/interface/listctrl.h index 4af80810f1..3ba6b6ba6f 100644 --- a/interface/listctrl.h +++ b/interface/listctrl.h @@ -44,41 +44,41 @@ 1. @beginStyleTable - @style{wxLC_LIST}: + @style{wxLC_LIST} Multicolumn list view, with optional small icons. Columns are computed automatically, i.e. you don't set columns as in wxLC_REPORT. In other words, the list wraps, unlike a wxListBox. - @style{wxLC_REPORT}: + @style{wxLC_REPORT} Single or multicolumn report view, with optional header. - @style{wxLC_VIRTUAL}: + @style{wxLC_VIRTUAL} The application provides items text on demand. May only be used with wxLC_REPORT. - @style{wxLC_ICON}: + @style{wxLC_ICON} Large icon view, with optional labels. - @style{wxLC_SMALL_ICON}: + @style{wxLC_SMALL_ICON} Small icon view, with optional labels. - @style{wxLC_ALIGN_TOP}: + @style{wxLC_ALIGN_TOP} Icons align to the top. Win32 default, Win32 only. - @style{wxLC_ALIGN_LEFT}: + @style{wxLC_ALIGN_LEFT} Icons align to the left. - @style{wxLC_AUTOARRANGE}: + @style{wxLC_AUTOARRANGE} Icons arrange themselves. Win32 only. - @style{wxLC_EDIT_LABELS}: + @style{wxLC_EDIT_LABELS} Labels are editable: the application will be notified when editing starts. - @style{wxLC_NO_HEADER}: + @style{wxLC_NO_HEADER} No header in report mode. - @style{wxLC_SINGLE_SEL}: + @style{wxLC_SINGLE_SEL} Single selection (default is multiple). - @style{wxLC_SORT_ASCENDING}: + @style{wxLC_SORT_ASCENDING} Sort in ascending order (must still supply a comparison callback in SortItems. - @style{wxLC_SORT_DESCENDING}: + @style{wxLC_SORT_DESCENDING} Sort in descending order (must still supply a comparison callback in SortItems. - @style{wxLC_HRULES}: + @style{wxLC_HRULES} Draws light horizontal rules between rows in report mode. - @style{wxLC_VRULES}: + @style{wxLC_VRULES} Draws light vertical rules between columns in report mode. @endStyleTable diff --git a/interface/mdi.h b/interface/mdi.h index a22d0b8c23..3d5f3b80bc 100644 --- a/interface/mdi.h +++ b/interface/mdi.h @@ -63,37 +63,37 @@ public: and is used in many popular Windows applications, such as Microsoft Word(TM). @beginStyleTable - @style{wxCAPTION}: + @style{wxCAPTION} Puts a caption on the frame. - @style{wxDEFAULT_FRAME_STYLE}: + @style{wxDEFAULT_FRAME_STYLE} Defined as wxMINIMIZE_BOX | wxMAXIMIZE_BOX | wxTHICK_FRAME | wxSYSTEM_MENU | wxCAPTION. - @style{wxHSCROLL}: + @style{wxHSCROLL} Displays a horizontal scrollbar in the client window, allowing the user to view child frames that are off the current view. - @style{wxICONIZE}: + @style{wxICONIZE} Display the frame iconized (minimized) (Windows only). - @style{wxMAXIMIZE}: + @style{wxMAXIMIZE} Displays the frame maximized (Windows only). - @style{wxMAXIMIZE_BOX}: + @style{wxMAXIMIZE_BOX} Displays a maximize box on the frame (Windows and Motif only). - @style{wxMINIMIZE}: + @style{wxMINIMIZE} Identical to wxICONIZE. - @style{wxMINIMIZE_BOX}: + @style{wxMINIMIZE_BOX} Displays a minimize box on the frame (Windows and Motif only). - @style{wxRESIZE_BORDER}: + @style{wxRESIZE_BORDER} Displays a resizeable border around the window (Motif only; for Windows, it is implicit in wxTHICK_FRAME). - @style{wxSTAY_ON_TOP}: + @style{wxSTAY_ON_TOP} Stay on top of other windows (Windows only). - @style{wxSYSTEM_MENU}: + @style{wxSYSTEM_MENU} Displays a system menu (Windows and Motif only). - @style{wxTHICK_FRAME}: + @style{wxTHICK_FRAME} Displays a thick frame around the window (Windows and Motif only). - @style{wxVSCROLL}: + @style{wxVSCROLL} Displays a vertical scrollbar in the client window, allowing the user to view child frames that are off the current view. - @style{wxFRAME_NO_WINDOW_MENU}: + @style{wxFRAME_NO_WINDOW_MENU} Under Windows, removes the Window menu that is normally added automatically. @endStyleTable @@ -294,29 +294,29 @@ public: which is itself a child of wxMDIParentFrame. @beginStyleTable - @style{wxCAPTION}: + @style{wxCAPTION} Puts a caption on the frame. - @style{wxDEFAULT_FRAME_STYLE}: + @style{wxDEFAULT_FRAME_STYLE} Defined as wxMINIMIZE_BOX | wxMAXIMIZE_BOX | wxTHICK_FRAME | wxSYSTEM_MENU | wxCAPTION. - @style{wxICONIZE}: + @style{wxICONIZE} Display the frame iconized (minimized) (Windows only). - @style{wxMAXIMIZE}: + @style{wxMAXIMIZE} Displays the frame maximized (Windows only). - @style{wxMAXIMIZE_BOX}: + @style{wxMAXIMIZE_BOX} Displays a maximize box on the frame (Windows and Motif only). - @style{wxMINIMIZE}: + @style{wxMINIMIZE} Identical to wxICONIZE. - @style{wxMINIMIZE_BOX}: + @style{wxMINIMIZE_BOX} Displays a minimize box on the frame (Windows and Motif only). - @style{wxRESIZE_BORDER}: + @style{wxRESIZE_BORDER} Displays a resizeable border around the window (Motif only; for Windows, it is implicit in wxTHICK_FRAME). - @style{wxSTAY_ON_TOP}: + @style{wxSTAY_ON_TOP} Stay on top of other windows (Windows only). - @style{wxSYSTEM_MENU}: + @style{wxSYSTEM_MENU} Displays a system menu (Windows and Motif only). - @style{wxTHICK_FRAME}: + @style{wxTHICK_FRAME} Displays a thick frame around the window (Windows and Motif only). @endStyleTable diff --git a/interface/minifram.h b/interface/minifram.h index f1751ab682..c11b24e602 100644 --- a/interface/minifram.h +++ b/interface/minifram.h @@ -19,29 +19,29 @@ using the "Mini frame" command of the "Generic dialogs" submenu. @beginStyleTable - @style{wxICONIZE}: + @style{wxICONIZE} Display the frame iconized (minimized) (Windows only). - @style{wxCAPTION}: + @style{wxCAPTION} Puts a caption on the frame. - @style{wxMINIMIZE}: + @style{wxMINIMIZE} Identical to wxICONIZE. - @style{wxMINIMIZE_BOX}: + @style{wxMINIMIZE_BOX} Displays a minimize box on the frame (Windows and Motif only). - @style{wxMAXIMIZE}: + @style{wxMAXIMIZE} Displays the frame maximized (Windows only). - @style{wxMAXIMIZE_BOX}: + @style{wxMAXIMIZE_BOX} Displays a maximize box on the frame (Windows and Motif only). - @style{wxCLOSE_BOX}: + @style{wxCLOSE_BOX} Displays a close box on the frame. - @style{wxSTAY_ON_TOP}: + @style{wxSTAY_ON_TOP} Stay on top of other windows (Windows only). - @style{wxSYSTEM_MENU}: + @style{wxSYSTEM_MENU} Displays a system menu (Windows and Motif only). - @style{wxTINY_CAPTION_HORIZ}: + @style{wxTINY_CAPTION_HORIZ} This style is obsolete and not used any longer. - @style{wxTINY_CAPTION_VERT}: + @style{wxTINY_CAPTION_VERT} This style is obsolete and not used any longer. - @style{wxRESIZE_BORDER}: + @style{wxRESIZE_BORDER} Displays a resizeable border around the window. @endStyleTable diff --git a/interface/msgdlg.h b/interface/msgdlg.h index 2ce39cc91b..6016e2eed8 100644 --- a/interface/msgdlg.h +++ b/interface/msgdlg.h @@ -158,23 +158,23 @@ public: following identifiers: @beginStyleTable - @style{wxYES_NO}: + @style{wxYES_NO} Puts Yes and No buttons on the message box. May be combined with wxCANCEL. - @style{wxCANCEL}: + @style{wxCANCEL} Puts a Cancel button on the message box. May only be combined with wxYES_NO or wxOK. - @style{wxOK}: + @style{wxOK} Puts an Ok button on the message box. May be combined with wxCANCEL. - @style{wxICON_EXCLAMATION}: + @style{wxICON_EXCLAMATION} Displays an exclamation mark symbol. - @style{wxICON_HAND}: + @style{wxICON_HAND} Displays an error symbol. - @style{wxICON_ERROR}: + @style{wxICON_ERROR} Displays an error symbol - the same as wxICON_HAND. - @style{wxICON_QUESTION}: + @style{wxICON_QUESTION} Displays a question mark symbol. - @style{wxICON_INFORMATION}: + @style{wxICON_INFORMATION} Displays an information symbol. The return value is one of: wxYES, wxNO, wxCANCEL, wxOK. For example: diff --git a/interface/notebook.h b/interface/notebook.h index f71444eb3b..c5c2c65e57 100644 --- a/interface/notebook.h +++ b/interface/notebook.h @@ -89,22 +89,22 @@ public: @b wxNotebookPage is a typedef for wxWindow. @beginStyleTable - @style{wxNB_TOP}: + @style{wxNB_TOP} Place tabs on the top side. - @style{wxNB_LEFT}: + @style{wxNB_LEFT} Place tabs on the left side. - @style{wxNB_RIGHT}: + @style{wxNB_RIGHT} Place tabs on the right side. - @style{wxNB_BOTTOM}: + @style{wxNB_BOTTOM} Place tabs under instead of above the notebook pages. - @style{wxNB_FIXEDWIDTH}: + @style{wxNB_FIXEDWIDTH} (Windows only) All tabs will have same width. - @style{wxNB_MULTILINE}: + @style{wxNB_MULTILINE} (Windows only) There can be several rows of tabs. - @style{wxNB_NOPAGETHEME}: + @style{wxNB_NOPAGETHEME} (Windows only) Display a solid colour on notebook pages, and not a gradient, which can reduce performance. - @style{wxNB_FLAT}: + @style{wxNB_FLAT} (Windows CE only) Show tabs in a flat style. @endStyleTable diff --git a/interface/odcombo.h b/interface/odcombo.h index 5eb7f5bbda..54e177f821 100644 --- a/interface/odcombo.h +++ b/interface/odcombo.h @@ -19,17 +19,17 @@ OnDrawItem(), OnMeasureItem() and OnMeasureItemWidth(). @beginStyleTable - @style{wxODCB_DCLICK_CYCLES}: + @style{wxODCB_DCLICK_CYCLES} Double-clicking cycles item if wxCB_READONLY is also used. Synonymous with wxCC_SPECIAL_DCLICK. - @style{wxODCB_STD_CONTROL_PAINT}: + @style{wxODCB_STD_CONTROL_PAINT} Control itself is not custom painted using OnDrawItem. Even if this style is not used, writable wxOwnerDrawnComboBox is never custom painted unless SetCustomPaintWidth() is called. @endStyleTable @beginEventTable{wxCommandEvent} - @event{EVT_COMBOBOX(id, func)}: + @event{EVT_COMBOBOX(id, func)} Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on the list is selected. Note that calling GetValue() returns the new value of selection. @@ -46,11 +46,11 @@ class wxOwnerDrawnComboBox : public wxComboCtrl { public: - /** Default constructor. */ wxOwnerDrawnComboBox(); + //@{ /** Constructor, creating and showing a owner-drawn combobox. @@ -64,8 +64,7 @@ public: @param pos Window position. @param size - Window size. If @c wxDefaultSize is specified then the window is - sized + Window size. If @c wxDefaultSize is specified then the window is sized appropriately. @param n Number of strings with which to initialise the control. @@ -169,10 +168,10 @@ public: Combines any of the following flag values: @beginStyleTable - @style{wxODCB_PAINTING_CONTROL}: + @style{wxODCB_PAINTING_CONTROL} Combo control is being painted, instead of a list item. Argument item may be @c wxNOT_FOUND in this case. - @style{wxODCB_PAINTING_SELECTED}: + @style{wxODCB_PAINTING_SELECTED} An item with selection background is being painted. DC text colour should already be correct. @endStyleTable diff --git a/interface/pickerbase.h b/interface/pickerbase.h index cfadac7b1f..d5c5c32a59 100644 --- a/interface/pickerbase.h +++ b/interface/pickerbase.h @@ -20,7 +20,7 @@ (see @c wxPB_USE_TEXTCTRL style) and to 0 otherwise. @beginStyleTable - @style{wxPB_USE_TEXTCTRL}: + @style{wxPB_USE_TEXTCTRL} Creates a text control to the left of the picker which is completely managed by this wxPickerBase class. @endStyleTable diff --git a/interface/progdlg.h b/interface/progdlg.h index 64bcabd946..f49e88e4a3 100644 --- a/interface/progdlg.h +++ b/interface/progdlg.h @@ -15,29 +15,29 @@ the elapsed, remaining and estimated time for the end of the progress. @beginStyleTable - @style{wxPD_APP_MODAL}: + @style{wxPD_APP_MODAL} Make the progress dialog modal. If this flag is not given, it is only "locally" modal - that is the input to the parent window is disabled, but not to the other ones. - @style{wxPD_AUTO_HIDE}: + @style{wxPD_AUTO_HIDE} Causes the progress dialog to disappear from screen as soon as the maximum value of the progress meter has been reached. - @style{wxPD_SMOOTH}: + @style{wxPD_SMOOTH} Causes smooth progress of the gauge control. - @style{wxPD_CAN_ABORT}: + @style{wxPD_CAN_ABORT} This flag tells the dialog that it should have a "Cancel" button which the user may press. If this happens, the next call to Update() will return @false. - @style{wxPD_CAN_SKIP}: + @style{wxPD_CAN_SKIP} This flag tells the dialog that it should have a "Skip" button which the user may press. If this happens, the next call to Update() will return @true in its skip parameter. - @style{wxPD_ELAPSED_TIME}: + @style{wxPD_ELAPSED_TIME} This flag tells the dialog that it should show elapsed time (since creating the dialog). - @style{wxPD_ESTIMATED_TIME}: + @style{wxPD_ESTIMATED_TIME} This flag tells the dialog that it should show estimated time. - @style{wxPD_REMAINING_TIME}: + @style{wxPD_REMAINING_TIME} This flag tells the dialog that it should show remaining time. @endStyleTable diff --git a/interface/radiobox.h b/interface/radiobox.h index c86fe2235c..d6173e4327 100644 --- a/interface/radiobox.h +++ b/interface/radiobox.h @@ -15,18 +15,18 @@ labelled buttons. @beginStyleTable - @style{wxRA_SPECIFY_ROWS}: + @style{wxRA_SPECIFY_ROWS} The major dimension parameter refers to the maximum number of rows. - @style{wxRA_SPECIFY_COLS}: + @style{wxRA_SPECIFY_COLS} The major dimension parameter refers to the maximum number of columns. - @style{wxRA_USE_CHECKBOX}: + @style{wxRA_USE_CHECKBOX} Use of the checkbox controls instead of radio buttons (currently supported only on PalmOS) @endStyleTable @beginEventTable{wxCommandEvent} - @event{EVT_RADIOBOX(id, func)}: + @event{EVT_RADIOBOX(id, func)} Process a wxEVT_COMMAND_RADIOBOX_SELECTED event, when a radiobutton is clicked. @endEventTable diff --git a/interface/radiobut.h b/interface/radiobut.h index 04b58e60b8..a95ce6659e 100644 --- a/interface/radiobut.h +++ b/interface/radiobut.h @@ -19,20 +19,20 @@ created, or there are no more radio buttons. @beginStyleTable - @style{wxRB_GROUP}: + @style{wxRB_GROUP} Marks the beginning of a new group of radio buttons. - @style{wxRB_SINGLE}: + @style{wxRB_SINGLE} In some circumstances, radio buttons that are not consecutive siblings trigger a hang bug in Windows (only). If this happens, add this style to mark the button as not belonging to a group, and implement the mutually-exclusive group behaviour yourself. - @style{wxRB_USE_CHECKBOX}: + @style{wxRB_USE_CHECKBOX} Use a checkbox button instead of radio button (currently supported only on PalmOS). @endStyleTable @beginEventTable{wxCommandEvent} - @event{EVT_RADIOBUTTON(id, func)}: + @event{EVT_RADIOBUTTON(id, func)} Process a wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the radiobutton is clicked. @endEventTable diff --git a/interface/richtext/richtextstyles.h b/interface/richtext/richtextstyles.h index 6bffbb61e6..a054d938cc 100644 --- a/interface/richtext/richtextstyles.h +++ b/interface/richtext/richtextstyles.h @@ -25,7 +25,7 @@ so that when a style is double-clicked, it is applied to the selection. @beginStyleTable - @style{wxRICHTEXTSTYLELIST_HIDE_TYPE_SELECTOR}: + @style{wxRICHTEXTSTYLELIST_HIDE_TYPE_SELECTOR} This style hides the category selection control. @endStyleTable diff --git a/interface/sashwin.h b/interface/sashwin.h index 8baad97cd4..a8fdb75076 100644 --- a/interface/sashwin.h +++ b/interface/sashwin.h @@ -18,21 +18,21 @@ via a wxSashEvent notification. @beginStyleTable - @style{wxSW_3D}: + @style{wxSW_3D} Draws a 3D effect sash and border. - @style{wxSW_3DSASH}: + @style{wxSW_3DSASH} Draws a 3D effect sash. - @style{wxSW_3DBORDER}: + @style{wxSW_3DBORDER} Draws a 3D effect border. - @style{wxSW_BORDER}: + @style{wxSW_BORDER} Draws a thin black border. @endStyleTable @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. - @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 dragging a sash. The event handler is called when windows with ids in the given range have their sashes dragged. diff --git a/interface/scrolbar.h b/interface/scrolbar.h index ad9f31dac2..be1aa3105c 100644 --- a/interface/scrolbar.h +++ b/interface/scrolbar.h @@ -16,9 +16,9 @@ events are received. @beginStyleTable - @style{wxSB_HORIZONTAL}: + @style{wxSB_HORIZONTAL} Specifies a horizontal scrollbar. - @style{wxSB_VERTICAL}: + @style{wxSB_VERTICAL} Specifies a vertical scrollbar. @endStyleTable diff --git a/interface/scrolwin.h b/interface/scrolwin.h index 7bd80daedc..a2df90181b 100644 --- a/interface/scrolwin.h +++ b/interface/scrolwin.h @@ -87,7 +87,7 @@ of (10,-90). @beginStyleTable - @style{wxRETAINED}: + @style{wxRETAINED} Uses a backing pixmap to speed refreshes. Motif only. @endStyleTable diff --git a/interface/slider.h b/interface/slider.h index 488c4b484f..415fe1938c 100644 --- a/interface/slider.h +++ b/interface/slider.h @@ -18,25 +18,25 @@ Slider events are handled in the same way as a scrollbar. @beginStyleTable - @style{wxSL_HORIZONTAL}: + @style{wxSL_HORIZONTAL} Displays the slider horizontally (this is the default). - @style{wxSL_VERTICAL}: + @style{wxSL_VERTICAL} Displays the slider vertically. - @style{wxSL_AUTOTICKS}: + @style{wxSL_AUTOTICKS} Displays tick marks. - @style{wxSL_LABELS}: + @style{wxSL_LABELS} Displays minimum, maximum and value labels. - @style{wxSL_LEFT}: + @style{wxSL_LEFT} Displays ticks on the left and forces the slider to be vertical. - @style{wxSL_RIGHT}: + @style{wxSL_RIGHT} Displays ticks on the right and forces the slider to be vertical. - @style{wxSL_TOP}: + @style{wxSL_TOP} Displays ticks on the top. - @style{wxSL_BOTTOM}: + @style{wxSL_BOTTOM} Displays ticks on the bottom (this is the default). - @style{wxSL_SELRANGE}: + @style{wxSL_SELRANGE} Allows the user to select a range on the slider. Windows only. - @style{wxSL_INVERSE}: + @style{wxSL_INVERSE} Inverses the mininum and maximum endpoints on the slider. Not compatible with wxSL_SELRANGE. @endStyleTable diff --git a/interface/spinbutt.h b/interface/spinbutt.h index 5bd9f8ae9f..e5af2d0435 100644 --- a/interface/spinbutt.h +++ b/interface/spinbutt.h @@ -55,14 +55,14 @@ public: required, 5.80 is recommended) the full 32 bit range is supported. @beginStyleTable - @style{wxSP_HORIZONTAL}: + @style{wxSP_HORIZONTAL} Specifies a horizontal spin button (note that this style is not supported in wxGTK). - @style{wxSP_VERTICAL}: + @style{wxSP_VERTICAL} Specifies a vertical spin button. - @style{wxSP_ARROW_KEYS}: + @style{wxSP_ARROW_KEYS} The user can use arrow keys to change the value. - @style{wxSP_WRAP}: + @style{wxSP_WRAP} The value wraps at the minimum and maximum. @endStyleTable diff --git a/interface/spinctrl.h b/interface/spinctrl.h index 046c98ccd2..f61d48efb5 100644 --- a/interface/spinctrl.h +++ b/interface/spinctrl.h @@ -14,9 +14,9 @@ wxSpinButton in one control. @beginStyleTable - @style{wxSP_ARROW_KEYS}: + @style{wxSP_ARROW_KEYS} The user can use arrow keys to change the value. - @style{wxSP_WRAP}: + @style{wxSP_WRAP} The value wraps at the minimum and maximum. @endStyleTable diff --git a/interface/splitter.h b/interface/splitter.h index 60648935f8..df7e890bf6 100644 --- a/interface/splitter.h +++ b/interface/splitter.h @@ -17,24 +17,24 @@ either programmatically or via the wxSplitterWindow user interface. @beginStyleTable - @style{wxSP_3D}: + @style{wxSP_3D} Draws a 3D effect border and sash. - @style{wxSP_3DSASH}: + @style{wxSP_3DSASH} Draws a 3D effect sash. - @style{wxSP_3DBORDER}: + @style{wxSP_3DBORDER} Synonym for wxSP_BORDER. - @style{wxSP_BORDER}: + @style{wxSP_BORDER} Draws a standard border. - @style{wxSP_NOBORDER}: + @style{wxSP_NOBORDER} No border (default). - @style{wxSP_NO_XP_THEME}: + @style{wxSP_NO_XP_THEME} Under Windows XP, switches off the attempt to draw the splitter using Windows XP theming, so the borders and sash will take on the pre-XP look. - @style{wxSP_PERMIT_UNSPLIT}: + @style{wxSP_PERMIT_UNSPLIT} Always allow to unsplit, even with the minimum pane size other than zero. - @style{wxSP_LIVE_UPDATE}: + @style{wxSP_LIVE_UPDATE} Don't draw XOR line but resize the child windows immediately. @endStyleTable diff --git a/interface/srchctrl.h b/interface/srchctrl.h index d526fe46b8..a376269ba2 100644 --- a/interface/srchctrl.h +++ b/interface/srchctrl.h @@ -14,28 +14,28 @@ control, and a cancel button. @beginStyleTable - @style{wxTE_PROCESS_ENTER}: + @style{wxTE_PROCESS_ENTER} The control will generate the event wxEVT_COMMAND_TEXT_ENTER (otherwise pressing Enter key is either processed internally by the 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 - 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 Ctrl-Enter to pass to the next control from the keyboard. - @style{wxTE_NOHIDESEL}: + @style{wxTE_NOHIDESEL} By default, the Windows text control doesn't show the selection when it doesn't have focus - use this style to force it to always show it. It doesn't do anything under other platforms. - @style{wxTE_LEFT}: + @style{wxTE_LEFT} The text in the control will be left-justified (default). - @style{wxTE_CENTRE}: + @style{wxTE_CENTRE} The text in the control will be centered (currently wxMSW and wxGTK2 only). - @style{wxTE_RIGHT}: + @style{wxTE_RIGHT} The text in the control will be right-justified (currently wxMSW and wxGTK2 only). - @style{wxTE_CAPITALIZE}: + @style{wxTE_CAPITALIZE} On PocketPC and Smartphone, causes the first letter to be capitalized. @endStyleTable diff --git a/interface/statline.h b/interface/statline.h index 2f624ef116..df71adf528 100644 --- a/interface/statline.h +++ b/interface/statline.h @@ -14,9 +14,9 @@ groups of controls. The line may be only vertical or horizontal. @beginStyleTable - @style{wxLI_HORIZONTAL}: + @style{wxLI_HORIZONTAL} Creates a horizontal line. - @style{wxLI_VERTICAL}: + @style{wxLI_VERTICAL} Creates a vertical line. @endStyleTable diff --git a/interface/stattext.h b/interface/stattext.h index 0f813f904b..dda0b92030 100644 --- a/interface/stattext.h +++ b/interface/stattext.h @@ -13,28 +13,28 @@ A static text control displays one or more lines of read-only text. @beginStyleTable - @style{wxALIGN_LEFT}: + @style{wxALIGN_LEFT} Align the text to the left - @style{wxALIGN_RIGHT}: + @style{wxALIGN_RIGHT} Align the text to the right - @style{wxALIGN_CENTRE}: + @style{wxALIGN_CENTRE} Center the text (horizontally) - @style{wxST_NO_AUTORESIZE}: + @style{wxST_NO_AUTORESIZE} By default, the control will adjust its size to exactly fit to the size of the text when SetLabel is called. If this style flag is given, the control will not change its size (this style is especially useful with controls which also have wxALIGN_RIGHT or CENTER style because otherwise they won't make sense any longer after a call to SetLabel) - @style{wxST_ELLIPSIZE_START}: + @style{wxST_ELLIPSIZE_START} If the text width exceeds the control width, replace the beginning of the text with an ellipsis - @style{wxST_ELLIPSIZE_MIDDLE}: + @style{wxST_ELLIPSIZE_MIDDLE} Same as above, but replace the text in the middle of the control with an ellipsis - @style{wxST_ELLIPSIZE_END}: + @style{wxST_ELLIPSIZE_END} Same as above, but replace the end of the text with an ellipsis - @style{wxST_MARKUP}: + @style{wxST_MARKUP} Support markup in the label; see SetLabel for more information @endStyleTable diff --git a/interface/statusbr.h b/interface/statusbr.h index 91d4cf1a56..ca46d9f91c 100644 --- a/interface/statusbr.h +++ b/interface/statusbr.h @@ -23,7 +23,7 @@ wxObject @beginStyleTable - @style{wxST_SIZEGRIP}: + @style{wxST_SIZEGRIP} On Windows 95, displays a gripper at right-hand side of the status bar. @endStyleTable diff --git a/interface/textctrl.h b/interface/textctrl.h index fa9f057773..e8384c07b9 100644 --- a/interface/textctrl.h +++ b/interface/textctrl.h @@ -630,65 +630,65 @@ public: single line or multi-line. @beginStyleTable - @style{wxTE_PROCESS_ENTER}: + @style{wxTE_PROCESS_ENTER} The control will generate the event wxEVT_COMMAND_TEXT_ENTER (otherwise pressing Enter key is either processed internally by the 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 - 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 Ctrl-Enter to pass to the next control from the keyboard. - @style{wxTE_MULTILINE}: + @style{wxTE_MULTILINE} The text control allows multiple lines. - @style{wxTE_PASSWORD}: + @style{wxTE_PASSWORD} The text will be echoed as asterisks. - @style{wxTE_READONLY}: + @style{wxTE_READONLY} The text will not be user-editable. - @style{wxTE_RICH}: + @style{wxTE_RICH} Use rich text control under Win32, this allows to have more than 64KB of text in the control even under Win9x. This style is ignored under other platforms. - @style{wxTE_RICH2}: + @style{wxTE_RICH2} Use rich text control version 2.0 or 3.0 under Win32, this style is ignored under other platforms - @style{wxTE_AUTO_URL}: + @style{wxTE_AUTO_URL} Highlight the URLs and generate the wxTextUrlEvents when mouse events occur over them. This style is only supported for wxTE_RICH Win32 and multi-line wxGTK2 text controls. - @style{wxTE_NOHIDESEL}: + @style{wxTE_NOHIDESEL} By default, the Windows text control doesn't show the selection when it doesn't have focus - use this style to force it to always show it. It doesn't do anything under other platforms. - @style{wxHSCROLL}: + @style{wxHSCROLL} A horizontal scrollbar will be created and used, so that text won't be wrapped. No effect under wxGTK1. - @style{wxTE_NO_VSCROLL}: + @style{wxTE_NO_VSCROLL} For multiline controls only: vertical scrollbar will never be created. This limits the amount of text which can be entered into the control to what can be displayed in it under MSW but not under GTK2. Currently not implemented for the other platforms. - @style{wxTE_LEFT}: + @style{wxTE_LEFT} The text in the control will be left-justified (default). - @style{wxTE_CENTRE}: + @style{wxTE_CENTRE} The text in the control will be centered (currently wxMSW and wxGTK2 only). - @style{wxTE_RIGHT}: + @style{wxTE_RIGHT} The text in the control will be right-justified (currently wxMSW and wxGTK2 only). - @style{wxTE_DONTWRAP}: + @style{wxTE_DONTWRAP} Same as wxHSCROLL style: don't wrap at all, show horizontal scrollbar instead. - @style{wxTE_CHARWRAP}: + @style{wxTE_CHARWRAP} Wrap the lines too long to be shown entirely at any position (wxUniv and wxGTK2 only). - @style{wxTE_WORDWRAP}: + @style{wxTE_WORDWRAP} Wrap the lines too long to be shown entirely at word boundaries (wxUniv and wxGTK2 only). - @style{wxTE_BESTWRAP}: + @style{wxTE_BESTWRAP} Wrap the lines at word boundaries or at any other character if there are words longer than the window width (this is the default). - @style{wxTE_CAPITALIZE}: + @style{wxTE_CAPITALIZE} On PocketPC and Smartphone, causes the first letter to be capitalized. @endStyleTable diff --git a/interface/tglbtn.h b/interface/tglbtn.h index 0ee09ceded..f52024d99c 100644 --- a/interface/tglbtn.h +++ b/interface/tglbtn.h @@ -21,7 +21,7 @@ controls() sample. @beginEventTable{wxCommandEvent} - @event{EVT_TOGGLEBUTTON(id, func)}: + @event{EVT_TOGGLEBUTTON(id, func)} Handles a toggle button click event. @endEventTable @@ -114,7 +114,7 @@ public: This control emits an update UI event. @beginEventTable{wxCommandEvent} - @event{EVT_TOGGLEBUTTON(id, func)}: + @event{EVT_TOGGLEBUTTON(id, func)} Handles a toggle button click event. @endEventTable diff --git a/interface/toolbar.h b/interface/toolbar.h index 972605973b..ca54757a53 100644 --- a/interface/toolbar.h +++ b/interface/toolbar.h @@ -19,36 +19,36 @@ @beginStyleTable - @style{wxTB_FLAT}: + @style{wxTB_FLAT} Gives the toolbar a flat look (Windows and GTK only). - @style{wxTB_DOCKABLE}: + @style{wxTB_DOCKABLE} Makes the toolbar floatable and dockable (GTK only). - @style{wxTB_HORIZONTAL}: + @style{wxTB_HORIZONTAL} Specifies horizontal layout (default). - @style{wxTB_VERTICAL}: + @style{wxTB_VERTICAL} Specifies vertical layout. - @style{wxTB_TEXT}: + @style{wxTB_TEXT} Shows the text in the toolbar buttons; by default only icons are shown. - @style{wxTB_NOICONS}: + @style{wxTB_NOICONS} Specifies no icons in the toolbar buttons; by default they are shown. - @style{wxTB_NODIVIDER}: + @style{wxTB_NODIVIDER} Specifies no divider (border) above the toolbar (Windows only). - @style{wxTB_NOALIGN}: + @style{wxTB_NOALIGN} Specifies no alignment with the parent window (Windows only, not very useful). - @style{wxTB_HORZ_LAYOUT}: + @style{wxTB_HORZ_LAYOUT} Shows the text and the icons alongside, not vertically stacked (Windows and GTK 2 only). This style must be used with wxTB_TEXT. - @style{wxTB_HORZ_TEXT}: + @style{wxTB_HORZ_TEXT} Combination of wxTB_HORZ_LAYOUT and wxTB_TEXT. - @style{wxTB_NO_TOOLTIPS}: + @style{wxTB_NO_TOOLTIPS} Don't show the short help tooltips for the tools when the mouse hovers over them. - @style{wxTB_BOTTOM}: + @style{wxTB_BOTTOM} Align the toolbar at the bottom of parent window. - @style{wxTB_RIGHT}: + @style{wxTB_RIGHT} Align the toolbar at the right side of parent window. @endStyleTable diff --git a/interface/toolbook.h b/interface/toolbook.h index 8a0cb2a1c8..fc657cc92b 100644 --- a/interface/toolbook.h +++ b/interface/toolbook.h @@ -21,10 +21,10 @@ action. @beginStyleTable - @style{wxTBK_BUTTONBAR}: + @style{wxTBK_BUTTONBAR} Use wxButtonToolBar-based implementation under Mac OS (ignored under other platforms.) - @style{wxTBK_HORZ_LAYOUT}: + @style{wxTBK_HORZ_LAYOUT} Shows the text and the icons alongside, not vertically stacked (only implement under Windows and GTK 2 platforms as it relies on wxTB_HORZ_LAYOUT flag support). diff --git a/interface/treectrl.h b/interface/treectrl.h index f4bff505a8..e63eef6432 100644 --- a/interface/treectrl.h +++ b/interface/treectrl.h @@ -80,41 +80,41 @@ public: in wxTreeEvent. @beginStyleTable - @style{wxTR_EDIT_LABELS}: + @style{wxTR_EDIT_LABELS} Use this style if you wish the user to be able to edit labels in the tree control. - @style{wxTR_NO_BUTTONS}: + @style{wxTR_NO_BUTTONS} For convenience to document that no buttons are to be drawn. - @style{wxTR_HAS_BUTTONS}: + @style{wxTR_HAS_BUTTONS} Use this style to show + and - buttons to the left of parent items. - @style{wxTR_NO_LINES}: + @style{wxTR_NO_LINES} Use this style to hide vertical level connectors. - @style{wxTR_FULL_ROW_HIGHLIGHT}: + @style{wxTR_FULL_ROW_HIGHLIGHT} Use this style to have the background colour and the selection highlight extend over the entire horizontal row of the tree control window. (This flag is ignored under Windows unless you specify wxTR_NO_LINES as well.) - @style{wxTR_LINES_AT_ROOT}: + @style{wxTR_LINES_AT_ROOT} Use this style to show lines between root nodes. Only applicable if wxTR_HIDE_ROOT is set and wxTR_NO_LINES is not set. - @style{wxTR_HIDE_ROOT}: + @style{wxTR_HIDE_ROOT} Use this style to suppress the display of the root node, effectively causing the first-level nodes to appear as a series of root nodes. - @style{wxTR_ROW_LINES}: + @style{wxTR_ROW_LINES} Use this style to draw a contrasting border between displayed rows. - @style{wxTR_HAS_VARIABLE_ROW_HEIGHT}: + @style{wxTR_HAS_VARIABLE_ROW_HEIGHT} Use this style to cause row heights to be just big enough to fit the content. If not set, all rows use the largest row height. The default is that this flag is unset. Generic only. - @style{wxTR_SINGLE}: + @style{wxTR_SINGLE} For convenience to document that only one item may be selected at a time. Selecting another item causes the current selection, if any, to be deselected. This is the default. - @style{wxTR_MULTIPLE}: + @style{wxTR_MULTIPLE} Use this style to allow a range of items to be selected. If a second range is selected, the current range, if any, is deselected. - @style{wxTR_DEFAULT_STYLE}: + @style{wxTR_DEFAULT_STYLE} The set of flags that are closest to the defaults for the native control for a particular toolkit. @endStyleTable diff --git a/interface/window.h b/interface/window.h index 657d9efa46..93cc5d7e52 100644 --- a/interface/window.h +++ b/interface/window.h @@ -33,37 +33,37 @@ changes the behaviour of the latter. @beginStyleTable - @style{wxBORDER_DEFAULT}: + @style{wxBORDER_DEFAULT} The window class will decide the kind of border to show, if any. - @style{wxBORDER_SIMPLE}: + @style{wxBORDER_SIMPLE} Displays a thin border around the window. wxSIMPLE_BORDER is the old name for this style. - @style{wxBORDER_SUNKEN}: + @style{wxBORDER_SUNKEN} Displays a sunken border. wxSUNKEN_BORDER is the old name for this style. - @style{wxBORDER_RAISED}: + @style{wxBORDER_RAISED} Displays a raised border. wxRAISED_BORDER is the old name for this style. - @style{wxBORDER_STATIC}: + @style{wxBORDER_STATIC} Displays a border suitable for a static control. wxSTATIC_BORDER is the old name for this style. Windows only. - @style{wxBORDER_THEME}: + @style{wxBORDER_THEME} Displays a native border suitable for a control, on the current platform. On Windows XP or Vista, this will be a themed border; on most other platforms a sunken border will be used. For more information for themed borders on Windows, please see Themed borders on Windows. - @style{wxBORDER_NONE}: + @style{wxBORDER_NONE} Displays no border, overriding the default border style for the window. wxNO_BORDER is the old name for this style. - @style{wxBORDER_DOUBLE}: + @style{wxBORDER_DOUBLE} This style is obsolete and should not be used. - @style{wxTRANSPARENT_WINDOW}: + @style{wxTRANSPARENT_WINDOW} The window is transparent, that is, it will not receive paint events. Windows only. - @style{wxTAB_TRAVERSAL}: + @style{wxTAB_TRAVERSAL} Use this to enable tab traversal for non-dialog windows. - @style{wxWANTS_CHARS}: + @style{wxWANTS_CHARS} Use this to indicate that the window wants to get all char/key events for all keys - even for keys like TAB or ENTER which are usually used for dialog navigation and which wouldn't be generated @@ -71,27 +71,27 @@ the arrows or etc., but would still like to have normal keyboard navigation take place, you should call Navigate in response to the key events for Tab and Shift-Tab. - @style{wxNO_FULL_REPAINT_ON_RESIZE}: + @style{wxNO_FULL_REPAINT_ON_RESIZE} On Windows, this style used to disable repainting the window completely when its size is changed. Since this behaviour is now the default, the style is now obsolete and no longer has an effect. - @style{wxVSCROLL}: + @style{wxVSCROLL} Use this style to enable a vertical scrollbar. Notice that this style cannot be used with native controls which don't support scrollbars nor with top-level windows in most ports. - @style{wxHSCROLL}: + @style{wxHSCROLL} Use this style to enable a horizontal scrollbar. The same limitations as for wxVSCROLL apply to this style. - @style{wxALWAYS_SHOW_SB}: + @style{wxALWAYS_SHOW_SB} If a window has scrollbars, disable them instead of hiding them when they are not needed (i.e. when the size of the window is big enough to not require the scrollbars to navigate it). This style is currently implemented for wxMSW, wxGTK and wxUniversal and does nothing on the other platforms. - @style{wxCLIP_CHILDREN}: + @style{wxCLIP_CHILDREN} Use this style to eliminate flicker caused by the background being repainted, then children being painted over them. Windows only. - @style{wxFULL_REPAINT_ON_RESIZE}: + @style{wxFULL_REPAINT_ON_RESIZE} Use this style to force a complete redraw of the window whenever it is resized instead of redrawing just the part of the window affected by resizing. Note that this was the behaviour by default @@ -102,25 +102,25 @@ @endStyleTable @beginExtraStyleTable - @style{wxWS_EX_VALIDATE_RECURSIVELY}: + @style{wxWS_EX_VALIDATE_RECURSIVELY} By default, Validate/TransferDataTo/FromWindow() only work on direct children of the window (compatible behaviour). Set this flag to make them recursively descend into all subwindows. - @style{wxWS_EX_BLOCK_EVENTS}: + @style{wxWS_EX_BLOCK_EVENTS} wxCommandEvents and the objects of the derived classes are forwarded to the parent window and so on recursively by default. Using this flag for the given window allows to block this propagation at this window, i.e. prevent the events from being propagated further upwards. Dialogs have this flag on by default. - @style{wxWS_EX_TRANSIENT}: + @style{wxWS_EX_TRANSIENT} Don't use this window as an implicit parent for the other windows: this must be used with transient windows as otherwise there is the risk of creating a dialog/frame with this window as a parent which would lead to a crash if the parent is destroyed before the child. - @style{wxWS_EX_PROCESS_IDLE}: + @style{wxWS_EX_PROCESS_IDLE} This window should always process idle events, even if the mode set by wxIdleEvent::SetMode is wxIDLE_PROCESS_SPECIFIED. - @style{wxWS_EX_PROCESS_UI_UPDATES}: + @style{wxWS_EX_PROCESS_UI_UPDATES} This window should always process UI update events, even if the mode set by wxUpdateUIEvent::SetMode is wxUPDATE_UI_PROCESS_SPECIFIED. -- 2.45.2