// Purpose: XRC format specification
// Author: Vaclav Slavik
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/*
- NOTE: to make doxygen happy about <custom-tags> we're forced to
- escape all < and > symbols which appear inside a doxygen comment
+ NOTE: To make doxygen happy about <custom-tags> we're forced to
+ escape all < and > symbols which appear inside a doxygen comment.
+ Also, don't use < and > symbols in section titles.
*/
/**
-@page xrc_format XRC file format
+@page overview_xrcformat XRC File Format
Table of contents:
- - @ref xrc_format_overview
- - @ref xrc_format_root
- - @ref xrc_format_objects
- - @ref xrc_format_object
- - @ref xrc_format_object_ref
- - @ref xrc_format_datatypes
- - @ref xrc_format_windows
- - @ref xrc_format_std_props
- - @ref xrc_format_controls
- - @ref xrc_format_sizers
- - @ref xrc_format_other_objects
- - @ref xrc_format_platform
- - @ref xrc_format_extending
- - @ref xrc_format_extending_subclass
- - @ref xrc_format_extending_unknown
- - @ref xrc_format_extending_custom
- - @ref xrc_format_packed
- - @ref xrc_format_oldversions
-
-This document describes the format of XRC resource files, as used by
-wxXmlResource.
+- @ref overview_xrcformat_overview
+- @ref overview_xrcformat_root
+- @ref overview_xrcformat_objects
+ - @ref overview_xrcformat_object
+ - @ref overview_xrcformat_object_ref
+- @ref overview_xrcformat_datatypes
+- @ref overview_xrcformat_windows
+ - @ref overview_xrcformat_std_props
+ - @ref overview_xrcformat_controls
+- @ref overview_xrcformat_sizers
+- @ref overview_xrcformat_other_objects
+- @ref overview_xrcformat_platform
+- @ref overview_xrcformat_idranges
+- @ref overview_xrcformat_extending
+ - @ref overview_xrcformat_extending_subclass
+ - @ref overview_xrcformat_extending_unknown
+ - @ref overview_xrcformat_extending_custom
+- @ref overview_xrcformat_packed
+- @ref overview_xrcformat_oldversions
+
+This document describes the format of XRC resource files, as used by wxXmlResource.
<hr>
-@section xrc_format_overview Overview
+@section overview_xrcformat_overview Overview
XRC file is a XML file with all of its elements in the
@c http://www.wxwidgets.org/wxxrc namespace. For backward compatibility,
windows. The objects may themselves contain child objects.
Objects defined at the top level, under the
-@ref xrc_format_root "root element", can be accessed using
+@ref overview_xrcformat_root "root element", can be accessed using
wxXmlResource::LoadDialog() and other LoadXXX methods. They must have
@c name attribute that is used as LoadXXX's argument (see
-@ref xrc_format_object for details).
+@ref overview_xrcformat_object for details).
Child objects are not directly accessible via wxXmlResource, they can only
be accessed using XRCCTRL().
-@section xrc_format_root Root element: \<resource\>
+@section overview_xrcformat_root Resource Root Element
The root element is always @c \<resource\>. It has one optional attribute, @c
version. If set, it specifies version of the file. In absence of @c version
@endcode
@c \<resource\> may have arbitrary number of
-@ref xrc_format_objects "object elements" as its children; they are referred
+@ref overview_xrcformat_objects "object elements" as its children; they are referred
to as @em toplevel objects in the rest of this document. Unlike objects defined
deeper in the hierarchy, toplevel objects @em must have their @c name attribute
set and it must be set to a value unique among root's children.
-@section xrc_format_objects Defining objects
+@section overview_xrcformat_objects Defining Objects
-@subsection xrc_format_object \<object\>
+@subsection overview_xrcformat_object Object Element
The @c \<object\> element represents a single object (typically a GUI element)
and it usually maps directly to a wxWidgets class instance. It has one
The @c subclass attribute optional name of class whose constructor will be
called instead of the constructor for "class".
-See @ref xrc_format_extending_subclass for more details.
+See @ref overview_xrcformat_extending_subclass for more details.
@c \<object\> element may -- and almost always do -- have children elements.
These come in two varieties:
-# Object's properties. A @em property is a value describing part of object's
behaviour, for example the "label" property on wxButton defines its label.
In the most common form, property is a single element with text content
- ("<label>Cancel</label>"), but they may use nested subelements too (e.g.
- @ref xrc_format_type_font "font property"). A property can only be
+ ("\<label\>Cancel\</label\>"), but they may use nested subelements too (e.g.
+ @ref overview_xrcformat_type_font "font property"). A property can only be
listed once in an object's definition.
-# Child objects. Window childs, sizers, sizer items or notebook pages
are all examples of child objects. They are represented using nested
@c \<object\> elements and are can be repeated more than once. The specifics
of which object classes are allowed as children are class-specific and
- are documented below in @ref xrc_format_controls.
+ are documented below in @ref overview_xrcformat_controls.
Example:
@code
@endcode
-@subsection xrc_format_object_ref <object_ref>
+@subsection overview_xrcformat_object_ref Object References
Anywhere an @c \<object\> element can be used, @c \<object_ref\> may be used
instead. @c \<object_ref\> is a @em reference to another named (i.e. with the
<object_ref ref="template" name="my_dlg">
<title>My dialog</title>
<centered>1</centered>
-</object>
+</object_ref>
@endcode
is identical to:
@code
-<object_ref ref="template" name="my_dlg">
+<object class="wxDialog" name="my_dlg">
<title>My dialog</title>
<size>400,400</size>
<centered>1</centered>
@endcode
-@section xrc_format_datatypes Data types
+@section overview_xrcformat_datatypes Data Types
There are several property data types that are frequently reused by different
properties. Rather than describing their format in the documentation of
their format.
-@subsection xrc_format_type_bool Boolean
+@subsection overview_xrcformat_type_bool Boolean
Boolean values are expressed using either "1" literal (true) or "0" (false).
-@subsection xrc_format_type_float Floating-point value
+@subsection overview_xrcformat_type_float Floating-point value
Floating point values use POSIX (C locale) formatting -- decimal separator
is "." regardless of the locale.
-@subsection xrc_format_type_colour Colour
+@subsection overview_xrcformat_type_colour Colour
Colour specification can be either any string colour representation accepted
by wxColour::Set() or any wxSYS_COLOUR_XXX symbolic name accepted by
@endcode
-@subsection xrc_format_type_size Size
+@subsection overview_xrcformat_type_size Size
Sizes and positions have the form of string with two comma-separated integer
components, with optional "d" suffix. Semi-formally:
100,50d
@endcode
-@subsection xrc_format_type_pos Position
+@subsection overview_xrcformat_type_pos Position
-Same as @ref xrc_format_type_size.
+Same as @ref overview_xrcformat_type_size.
-@subsection xrc_format_type_dimension Dimension
+@subsection overview_xrcformat_type_dimension Dimension
-Similarly to @ref xrc_format_type_size "sizes", dimensions are expressed
+Similarly to @ref overview_xrcformat_type_size "sizes", dimensions are expressed
as integers with optional "d" suffix. When "d" suffix is used, the integer
preceding it is interpreted as dialog units in the parent window.
-@subsection xrc_format_type_text Text
+@subsection overview_xrcformat_type_text Text
String properties use several escape sequences that are translated according to
the following table:
it is still possible to use "&". The latter has to be encoded as "&",
though, so using "_" is more convenient.
-@see @ref xrc_format_pre_v2530, @ref xrc_format_pre_v2301
+@see @ref overview_xrcformat_pre_v2530, @ref overview_xrcformat_pre_v2301
-@subsection xrc_format_type_text_notrans Non-translatable text
+@subsection overview_xrcformat_type_text_notrans Non-Translatable Text
-Like @ref xrc_format_type_text, but the text is never translated and
+Like @ref overview_xrcformat_type_text, but the text is never translated and
@c translate attribute cannot be used.
-@subsection xrc_format_type_string URL
+@subsection overview_xrcformat_type_string String
-An unformatted string. Unlike with @ref xrc_format_type_text, no escaping
+An unformatted string. Unlike with @ref overview_xrcformat_type_text, no escaping
or translations are done.
-@subsection xrc_format_type_url URL
+@subsection overview_xrcformat_type_url URL
Any URL accepted by wxFileSystem (typically relative to XRC file's location,
-but can be absolute too). Unlike with @ref xrc_format_type_text, no escaping
+but can be absolute too). Unlike with @ref overview_xrcformat_type_text, no escaping
or translations are done.
-@subsection xrc_format_type_bitmap Bitmap
+@subsection overview_xrcformat_type_bitmap Bitmap
Bitmap properties contain specification of a single bitmap or icon. In the most
basic form, their text value is simply a relative filename (or another
Specifying the bitmap directly and using @c stock_id are mutually exclusive.
-@subsection xrc_format_type_style Style
+@subsection overview_xrcformat_type_style Style
Style properties (such as window's style or sizer flags) use syntax similar to
C++: the style value is OR-combination of individual flags. Symbolic names
@endcode
-@subsection xrc_format_type_font Font
+@subsection overview_xrcformat_type_font Font
XRC uses similar, but more flexible, abstract description of fonts to that
used by wxFont class. A font can be described either in terms of its elementary
@row3col{family, enum,
One of "roman", "script", "decorative", "swiss", "modern" or "teletype"
(default: roman).}
-@row3col{underlined, @ref xrc_format_type_bool,
+@row3col{underlined, @ref overview_xrcformat_type_bool,
Whether the font should be underlined (default: 0).}
@row3col{face, ,
Comma-separated list of face names; the first one available is used
@endcode
-@section xrc_format_windows Controls and windows
+@section overview_xrcformat_windows Controls and Windows
This section describes support wxWindow-derived classes in XRC format.
-@subsection xrc_format_std_props Standard properties
+@subsection overview_xrcformat_std_props Standard Properties
The following properties are always (unless stated otherwise in
control-specific docs) available for @em windows objects. They are omitted
@beginTable
@hdr3col{property, type, description}
-@row3col{pos, @ref xrc_format_type_pos,
+@row3col{pos, @ref overview_xrcformat_type_pos,
Initial position of the window (default: wxDefaultPosition).}
-@row3col{size, @ref xrc_format_type_size,
+@row3col{size, @ref overview_xrcformat_type_size,
Initial size of the window (default: wxDefaultSize).}
-@row3col{style, @ref xrc_format_type_style,
+@row3col{style, @ref overview_xrcformat_type_style,
Window style for this control. The allowed values depend on what
window is being created, consult respective class' constructor
documentation for details (default: window-dependent default, usually
wxFOO_DEFAULT_STYLE if defined for class wxFoo, 0 if not).}
-@row3col{exstyle, @ref xrc_format_type_style,
+@row3col{exstyle, @ref overview_xrcformat_type_style,
Extra style for the window, if any. See wxWindow::SetExtraStyle()
(default: not set).}
-@row3col{fg, @ref xrc_format_type_colour,
+@row3col{fg, @ref overview_xrcformat_type_colour,
Foreground colour of the window (default: window's default).}
-@row3col{bg, @ref xrc_format_type_colour,
+@row3col{ownfg, @ref overview_xrcformat_type_colour,
+ Non-inheritable foreground colour of the window, see
+ wxWindow::SetOwnForegroundColour() (default: none).}
+@row3col{bg, @ref overview_xrcformat_type_colour,
Background colour of the window (default: window's default).}
-@row3col{enabled, @ref xrc_format_type_bool,
+@row3col{ownbg, @ref overview_xrcformat_type_colour,
+ Non-inheritable background colour of the window, see
+ wxWindow::SetOwnBackgroundColour() (default: none).}
+@row3col{enabled, @ref overview_xrcformat_type_bool,
If set to 0, the control is disabled (default: 1).}
-@row3col{hidden, @ref xrc_format_type_bool,
+@row3col{hidden, @ref overview_xrcformat_type_bool,
If set to 1, the control is created hidden (default: 0).}
-@row3col{tooltip, @ref xrc_format_type_text,
+@row3col{tooltip, @ref overview_xrcformat_type_text,
Tooltip to use for the control (default: not set).}
-@row3col{font, @ref xrc_format_type_font,
+@row3col{font, @ref overview_xrcformat_type_font,
Font to use for the control (default: window's default).}
-@row3col{help, @ref xrc_format_type_text,
+@row3col{ownfont, @ref overview_xrcformat_type_font,
+ Non-inheritable font to use for the control, see
+ wxWindow::SetOwnFont() (default: none).}
+@row3col{help, @ref overview_xrcformat_type_text,
Context-sensitive help for the control, used by wxHelpProvider
(default: not set).}
@endTable
All of these properties are optional.
-@subsection xrc_format_controls Supported controls
+@subsection overview_xrcformat_controls Supported Controls
This section lists all controls supported by default. For each control, its
control-specific properties are listed. If the control can have child objects,
@beginTable
@hdr3col{property, type, description}
-@row3col{animation, @ref xrc_format_type_url,
+@row3col{animation, @ref overview_xrcformat_type_url,
Animation file to load into the control (required).}
@endTable
+@subsubsection xrc_wxbannerwindow wxBannerWindow
+
+@beginTable
+@hdr3col{property, type, description}
+@row3col{direction, @c wxLEFT|wxRIGHT|wxTOP|wxBOTTOM,
+ The side along which the banner will be positioned.}
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
+ Bitmap to use as the banner background.}
+@row3col{title, @ref overview_xrcformat_type_text,
+ Banner title, should be single line.}
+@row3col{message, @ref overview_xrcformat_type_text,
+ Possibly multi-line banner message.}
+@row3col{gradient-start, @ref overview_xrcformat_type_colour,
+ Starting colour of the gradient used as banner background. Can't be used if
+ a valid bitmap is specified.}
+@row3col{gradient-end, @ref overview_xrcformat_type_colour,
+ End colour of the gradient used as banner background. Can't be used if
+ a valid bitmap is specified.}
+@endTable
+
+
@subsubsection xrc_wxbitmapbutton wxBitmapButton
@beginTable
@hdr3col{property, type, description}
-@row3col{default, @ref xrc_format_type_bool,
+@row3col{default, @ref overview_xrcformat_type_bool,
Should this button be the default button in dialog (default: 0)?}
-@row3col{bitmap, @ref xrc_format_type_bitmap,
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
Bitmap to show on the button (required).}
-@row3col{selected, @ref xrc_format_type_bitmap,
+@row3col{selected, @ref overview_xrcformat_type_bitmap,
Bitmap to show when the button is selected (default: none, same as @c bitmap).}
-@row3col{focus, @ref xrc_format_type_bitmap,
+@row3col{focus, @ref overview_xrcformat_type_bitmap,
Bitmap to show when the button has focus (default: none, same as @c bitmap).}
-@row3col{disabled, @ref xrc_format_type_bitmap,
+@row3col{disabled, @ref overview_xrcformat_type_bitmap,
Bitmap to show when the button is disabled (default: none, same as @c bitmap).}
-@row3col{hover, @ref xrc_format_type_bitmap,
+@row3col{hover, @ref overview_xrcformat_type_bitmap,
Bitmap to show when mouse cursor hovers above the bitmap (default: none, same as @c bitmap).}
@endTable
@hdr3col{property, type, description}
@row3col{selection, integer,
Index of the initially selected item or -1 for no selection (default: -1).}
-@row3col{value, @ref xrc_format_type_string,
+@row3col{value, @ref overview_xrcformat_type_string,
Initial value in the control (doesn't have to be one of @ content values;
default: empty).}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{text, @ref xrc_format_type_text,
+@row3col{text, @ref overview_xrcformat_type_text,
Item's label (required).}
-@row3col{bitmap, @ref xrc_format_type_bitmap,
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
Item's bitmap (default: no bitmap).}
@endTable
@endcode
-@subsubsection xrc_wxbutton wxButton
+@subsubsection xrc_wxbitmaptogglebutton wxBitmapToggleButton
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
Label to display on the button (required).}
-@row3col{default, @ref xrc_format_type_bool,
- Should this button be the default button in dialog (default: 0)?}
+@row3col{checked, @ref overview_xrcformat_type_bool,
+ Should the button be checked/pressed initially (default: 0)?}
+@endTable
+
+
+@subsubsection xrc_wxbutton wxButton
+
+@beginTable
+@hdr3col{property, type, description}
+@row3col{label, @ref overview_xrcformat_type_text,
+ Label to display on the button (may be empty if only bitmap is used).}
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
+ Bitmap to display in the button (optional).}
+@row3col{bitmapposition, @c wxLEFT|wxRIGHT|wxTOP|wxBOTTOM,
+ Position of the bitmap in the button, see wxButton::SetBitmapPosition().}
+@row3col{default, @ref overview_xrcformat_type_bool,
+ Should this button be the default button in dialog (default: 0)?}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Label to use for the checkbox (required).}
-@row3col{checked, @ref xrc_format_type_bool,
+@row3col{checked, @ref overview_xrcformat_type_bool,
Should the checkbox be checked initially (default: 0)?}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{content, ,
+@row3col{content, items,
Content of the control; this property has any number of @c \<item\> XML
elements as its children, with the items text as their text values
(default: empty).}
@hdr3col{property, type, description}
@row3col{selection, integer,
Index of the initially selected item or -1 for no selection (default: -1).}
-@row3col{content, ,
+@row3col{content, items,
Content of the control; this property has any number of @c \<item\> XML
elements as its children, with the items text as their text values
(default: empty).}
@subsubsection xrc_wxchoicebook wxChoicebook
-No additional properties.
-
A choicebook can have one or more child objects of the @c choicebookpage
pseudo-class (similarly to @ref xrc_wxnotebook "wxNotebook" and its
-@c notebookpage). @c choicebookpage objects have the following properties:
+@c notebookpage) and one child object of the @ref xrc_wximagelist class.
+@c choicebookpage objects have the following properties:
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Sheet page's title (required).}
-@row3col{bitmap, @ref xrc_format_type_bitmap,
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
Bitmap shown alongside the label (default: none).}
-@row3col{selected, @ref xrc_format_type_bool,
+@row3col{image, integer,
+ The zero-based index of the image associated with the item
+ into the image list.}
+@row3col{selected, @ref overview_xrcformat_type_bool,
Is the page selected initially (only one page can be selected; default: 0)?}
@endTable
Each @c choicebookpage has exactly one non-toplevel window as its child.
+@subsubsection xrc_wxcommandlinkbutton wxCommandLinkButton
+
+The wxCommandLinkButton contains a main title-like @c label and an optional
+@c note for longer description. The main @c label and the @c note can be
+concatenated into a single string using a new line character between them
+(notice that the @c note part can have more new lines in it).
+
+@beginTable
+@hdr3col{property, type, description}
+@row3col{label, @ref overview_xrcformat_type_text,
+ First line of text on the button, typically the label of an action that
+ will be made when the button is pressed. }
+@row3col{note, @ref overview_xrcformat_type_text,
+ Second line of text describing the action performed when the button is pressed. }
+@endTable
+
+
@subsubsection xrc_wxcollapsiblepane wxCollapsiblePane
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Label to use for the collapsible section (required).}
-@row3col{collapsed, @ref xrc_format_type_bool,
+@row3col{collapsed, @ref overview_xrcformat_type_bool,
Should the pane be collapsed initially (default: 0)?}
@endTable
wxCollapsiblePane may contain single optional child object of the @c panewindow
pseudo-class type. @c panewindow itself must contain exactly one child that
-is a @ref xrc_format_sizers "sizer" or a non-toplevel window
+is a @ref overview_xrcformat_sizers "sizer" or a non-toplevel window
object.
@beginTable
@hdr3col{property, type, description}
-@row3col{value, @ref xrc_format_type_colour,
+@row3col{value, @ref overview_xrcformat_type_colour,
Initial value of the control (default: wxBLACK).}
@endTable
@hdr3col{property, type, description}
@row3col{selection, integer,
Index of the initially selected item or -1 for no selection (default: not used).}
-@row3col{content, ,
+@row3col{content, items,
Content of the control; this property has any number of @c \<item\> XML
elements as its children, with the items text as their text values
(default: empty).}
-@row3col{value, @ref xrc_format_type_string,
+@row3col{value, @ref overview_xrcformat_type_string,
Initial value in the control (doesn't have to be one of @ content values;
default: empty).}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{title, @ref xrc_format_type_text,
+@row3col{title, @ref overview_xrcformat_type_text,
Dialog's title (default: empty).}
-@row3col{icon, @ref xrc_format_type_bitmap,
+@row3col{icon, @ref overview_xrcformat_type_bitmap,
Dialog's icon (default: not used).}
-@row3col{centered, @ref xrc_format_type_bool,
+@row3col{centered, @ref overview_xrcformat_type_bool,
Whether the dialog should be centered on the screen (default: 0).}
@endTable
wxDialog may have optional children: either exactly one
-@ref xrc_format_sizers "sizer" child or any number of non-toplevel window
+@ref overview_xrcformat_sizers "sizer" child or any number of non-toplevel window
objects. If sizer child is used, it sets
@ref wxSizer::SetSizeHints() "size hints" too.
@beginTable
@hdr3col{property, type, description}
-@row3col{value, @ref xrc_format_type_string,
+@row3col{value, @ref overview_xrcformat_type_string,
Initial value of the control (default: empty).}
-@row3col{message, @ref xrc_format_type_text,
+@row3col{message, @ref overview_xrcformat_type_text,
Message shown to the user in wxDirDialog shown by the control (required).}
@endTable
+@subsubsection xrc_wxfilectrl wxFileCtrl
+
+@beginTable
+@hdr3col{property, type, description}
+@row3col{defaultdirectory, @ref overview_xrcformat_type_string,
+ Sets the current directory displayed in the control. }
+@row3col{defaultfilename, @ref overview_xrcformat_type_string,
+ Selects a certain file.}
+@row3col{wildcard, @ref overview_xrcformat_type_string,
+ Sets the wildcard, which can contain multiple file types, for example:
+ "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".}
+@endTable
+
+
@subsubsection xrc_wxfilepickerctrl wxFilePickerCtrl
@beginTable
@hdr3col{property, type, description}
-@row3col{value, @ref xrc_format_type_string,
+@row3col{value, @ref overview_xrcformat_type_string,
Initial value of the control (default: empty).}
-@row3col{message, @ref xrc_format_type_text,
- Message shown to the user in wxDirDialog shown by the control (required).}
-@row3col{wildcard, @ref xrc_format_type_string,
+@row3col{message, @ref overview_xrcformat_type_text,
Message shown to the user in wxDirDialog shown by the control (required).}
+@row3col{wildcard, @ref overview_xrcformat_type_string,
+ Sets the wildcard, which can contain multiple file types, for example:
+ "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{value, @ref xrc_format_type_font,
+@row3col{value, @ref overview_xrcformat_type_font,
Initial value of the control (default: wxNORMAL_FONT).}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{title, @ref xrc_format_type_text,
+@row3col{title, @ref overview_xrcformat_type_text,
Frame's title (default: empty).}
-@row3col{icon, @ref xrc_format_type_bitmap,
+@row3col{icon, @ref overview_xrcformat_type_bitmap,
Frame's icon (default: not used).}
-@row3col{centered, @ref xrc_format_type_bool,
+@row3col{centered, @ref overview_xrcformat_type_bool,
Whether the frame should be centered on the screen (default: 0).}
@endTable
wxFrame may have optional children: either exactly one
-@ref xrc_format_sizers "sizer" child or any number of non-toplevel window
+@ref overview_xrcformat_sizers "sizer" child or any number of non-toplevel window
objects. If sizer child is used, it sets
@ref wxSizer::SetSizeHints() "size hints" too.
@beginTable
@hdr3col{property, type, description}
@row3col{range, integer,
- Maximum value of the gauge (default: wxGAUGE_DEFAULT_RANGE).}
+ Maximum value of the gauge (default: 100).}
@row3col{value, integer,
Initial value of the control (default: 0).}
-@row3col{shadow, @ref xrc_format_type_dimension,
+@row3col{shadow, @ref overview_xrcformat_type_dimension,
Rendered shadow size (default: none; ignored by most platforms).}
-@row3col{bezel, @ref xrc_format_type_dimension,
+@row3col{bezel, @ref overview_xrcformat_type_dimension,
Rendered bezel size (default: none; ignored by most platforms).}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{defaultfolder, @ref xrc_format_type_text,
+@row3col{defaultfolder, @ref overview_xrcformat_type_text,
Initial folder (default: empty).}
-@row3col{filter, @ref xrc_format_type_text,
+@row3col{filter, @ref overview_xrcformat_type_text,
Filter string, using the same syntax as used by wxFileDialog, e.g.
"All files (*.*)|*.*|JPEG files (*.jpg)|*.jpg" (default: empty).}
@row3col{defaultfilter, integer,
@beginTable
@hdr3col{property, type, description}
-@row3col{url, @ref xrc_format_type_url,
+@row3col{url, @ref overview_xrcformat_type_url,
Page to display in the window.}
-@row3col{htmlcode, @ref xrc_format_type_text,
+@row3col{htmlcode, @ref overview_xrcformat_type_text,
HTML markup to display in the window.}
-@row3col{borders, @ref xrc_format_type_dimension,
+@row3col{borders, @ref overview_xrcformat_type_dimension,
Border around HTML content (default: 0).}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Label to display on the control (required).}
-@row3col{url, @ref xrc_format_type_url,
+@row3col{url, @ref overview_xrcformat_type_url,
URL to open when the link is clicked (required).}
@endTable
+@subsubsection xrc_wximagelist wxImageList
+
+The imagelist can be used as a child object for the following classes:
+ - @ref xrc_wxchoicebook
+ - @ref xrc_wxlistbook
+ - @ref xrc_wxlistctrl
+ - @ref xrc_wxnotebook
+ - @ref xrc_wxtreebook
+ - @ref xrc_wxtreectrl
+
+The available properties are:
+
+@beginTable
+@hdr3col{property, type, description}
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
+ Adds a new image by keeping its optional mask bitmap (see below).}
+@row3col{mask, @ref overview_xrcformat_type_bool,
+ If masks should be created for all images (default: true).}
+@row3col{size, @ref overview_xrcformat_type_size,
+ The size of the images in the list (default: the size of the first bitmap).}
+@endTable
+
+Example:
+@code
+<imagelist>
+ <size>32,32</size>
+ <bitmap stock_id="wxART_QUESTION"/>
+ <bitmap stock_id="wxART_INFORMATION"/>
+</imagelist>
+@endcode
+
+In the specific case of the @ref xrc_wxlistctrl, the tag can take the name
+@c \<imagelist-small\> to define the 'small' image list, related to the flag
+@c wxIMAGE_LIST_SMALL (see wxListCtrl documentation).
+
+
@subsubsection xrc_wxlistbox wxListBox
@beginTable
@hdr3col{property, type, description}
@row3col{selection, integer,
Index of the initially selected item or -1 for no selection (default: -1).}
-@row3col{content, ,
+@row3col{content, items,
Content of the control; this property has any number of @c \<item\> XML
elements as its children, with the items text as their text values
(default: empty).}
@subsubsection xrc_wxlistbook wxListbook
-No additional properties.
-
A listbook can have one or more child objects of the @c listbookpage
pseudo-class (similarly to @ref xrc_wxnotebook "wxNotebook" and its
-@c notebookpage). @c listbookpage objects have the following properties:
+@c notebookpage) and one child object of the @ref xrc_wximagelist class.
+@c listbookpage objects have the following properties:
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Sheet page's title (required).}
-@row3col{bitmap, @ref xrc_format_type_bitmap,
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
Bitmap shown alongside the label (default: none).}
-@row3col{selected, @ref xrc_format_type_bool,
+@row3col{image, integer,
+ The zero-based index of the image associated with the item
+ into the image list.}
+@row3col{selected, @ref overview_xrcformat_type_bool,
Is the page selected initially (only one page can be selected; default: 0)?}
@endTable
@subsubsection xrc_wxlistctrl wxListCtrl
-No additional properties.
+A list control can have one or more child objects of the class @ref xrc_wxlistitem
+and one or more objects of the @ref xrc_wximagelist class. The latter is
+defined either using @c \<imagelist\> tag for the control with @c wxLC_ICON
+style or using @c \<imagelist-small\> tag for the control with @c
+wxLC_SMALL_ICON style.
+
+Report mode list controls (i.e. created with @c wxLC_REPORT style) can in
+addition have one or more @ref xrc_wxlistcol child elements.
+
+@paragraph xrc_wxlistcol listcol
+
+The @c listcol class can only be used for wxListCtrl children. It can have the
+following properties:
+@beginTable
+@hdr3col{property, type, description}
+@row3col{align, wxListColumnFormat,
+ The alignment for the item.
+ Can be one of @c wxLIST_FORMAT_LEFT, @c wxLIST_FORMAT_RIGHT or
+ @c wxLIST_FORMAT_CENTRE.}
+@row3col{text, @ref overview_xrcformat_type_string,
+ The title of the column. }
+@row3col{width, integer,
+ The column width. }
+@row3col{image, integer,
+ The zero-based index of the image associated with the item in the 'small' image list. }
+@endTable
+
+The columns are appended to the control in order of their appearance and may be
+referenced by 0-based index in the @c col attributes of subsequent @c listitem
+objects.
+
+@paragraph xrc_wxlistitem listitem
+
+The @c listitem is a child object for the class @ref xrc_wxlistctrl.
+It can have the following properties:
+
+@beginTable
+@hdr3col{property, type, description}
+@row3col{align, wxListColumnFormat,
+ The alignment for the item.
+ Can be one of @c wxLIST_FORMAT_LEFT, @c wxLIST_FORMAT_RIGHT or
+ @c wxLIST_FORMAT_CENTRE.}
+@row3col{bg, @ref overview_xrcformat_type_colour,
+ The background color for the item.}
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
+ Add a bitmap to the (normal) @ref xrc_wximagelist associated with the
+ @ref xrc_wxlistctrl parent and associate it with this item.
+ If the imagelist is not defined it will be created implicitly.}
+@row3col{bitmap-small, @ref overview_xrcformat_type_bitmap,
+ Add a bitmap in the 'small' @ref xrc_wximagelist associated with the
+ @ref xrc_wxlistctrl parent and associate it with this item.
+ If the 'small' imagelist is not defined it will be created implicitly.}
+@row3col{col, integer,
+ The zero-based column index.}
+@row3col{image, integer,
+ The zero-based index of the image associated with the item
+ in the (normal) image list.}
+@row3col{image-small, integer,
+ The zero-based index of the image associated with the item
+ in the 'small' image list.}
+@row3col{data, integer,
+ The client data for the item.}
+@row3col{font, @ref overview_xrcformat_type_font,
+ The font for the item.}
+@row3col{image, integer,
+ The zero-based index of the image associated with the item
+ into the image list.}
+@row3col{state, @ref overview_xrcformat_type_style,
+ The item state. Can be any combination of the following values:
+ - @c wxLIST_STATE_FOCUSED: The item has the focus.
+ - @c wxLIST_STATE_SELECTED: The item is selected.}
+@row3col{text, @ref overview_xrcformat_type_string,
+ The text label for the item. }
+@row3col{textcolour, @ref overview_xrcformat_type_colour,
+ The text colour for the item. }
+@endTable
+
+Notice that the item position can't be specified here, the items are appended
+to the list control in order of their appearance.
@subsubsection xrc_wxmdiparentframe wxMDIParentFrame
xrc_wxmdiparentframe.
wxMDIChildFrame may have optional children: either exactly one
-@ref xrc_format_sizers "sizer" child or any number of non-toplevel window
+@ref overview_xrcformat_sizers "sizer" child or any number of non-toplevel window
objects. If sizer child is used, it sets
@ref wxSizer::SetSizeHints() "size hints" too.
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Menu's label (default: empty, but required for menus other
than popup menus).}
-@row3col{help, @ref xrc_format_type_text,
+@row3col{help, @ref overview_xrcformat_type_text,
Help shown in statusbar when the menu is selected (only for submenus
of another wxMenu, default: none).}
-@row3col{enabled, @ref xrc_format_type_bool,
+@row3col{enabled, @ref overview_xrcformat_type_bool,
Is the submenu item enabled (only for submenus of another wxMenu,
default: 1)?}
@endTable
Note that unlike most controls, wxMenu does @em not have
-@ref xrc_format_std_props.
+@ref overview_xrcformat_std_props.
A menu object can have one or more child objects of the wxMenuItem or wxMenu
classes or @c break or @c separator pseudo-classes.
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Item's label (required).}
-@row3col{accel, @ref xrc_format_type_text_notrans,
+@row3col{accel, @ref overview_xrcformat_type_text_notrans,
Item's accelerator (default: none).}
-@row3col{radio, @ref xrc_format_type_bool,
+@row3col{radio, @ref overview_xrcformat_type_bool,
Item's kind is wxITEM_RADIO (default: 0)?}
-@row3col{checkable, @ref xrc_format_type_bool,
+@row3col{checkable, @ref overview_xrcformat_type_bool,
Item's kind is wxITEM_CHECK (default: 0)?}
-@row3col{bitmap, @ref xrc_format_type_bitmap,
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
Bitmap to show with the item (default: none).}
-@row3col{bitmap2, @ref xrc_format_type_bitmap,
+@row3col{bitmap2, @ref overview_xrcformat_type_bitmap,
Bitmap for the checked state (wxMSW, if checkable; default: none).}
-@row3col{help, @ref xrc_format_type_text,
+@row3col{help, @ref overview_xrcformat_type_text,
Help shown in statusbar when the item is selected (default: none).}
-@row3col{enabled, @ref xrc_format_type_bool,
+@row3col{enabled, @ref overview_xrcformat_type_bool,
Is the item enabled (default: 1)?}
-@row3col{checked, @ref xrc_format_type_bool,
+@row3col{checked, @ref overview_xrcformat_type_bool,
Is the item checked initially (default: 0)?}
@endTable
@subsubsection xrc_wxmenubar wxMenuBar
No properties. Note that unlike most controls, wxMenuBar does @em not have
-@ref xrc_format_std_props.
+@ref overview_xrcformat_std_props.
A menubar can have one or more child objects of the @ref xrc_wxmenu "wxMenu"
class.
@subsubsection xrc_wxnotebook wxNotebook
-No additional properties.
-
A notebook can have one or more child objects of the @c notebookpage
-pseudo-class. @c notebookpage objects have the following properties:
+pseudo-class and one child object of the @ref xrc_wximagelist class.
+@c notebookpage objects have the following properties:
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Page's title (required).}
-@row3col{bitmap, @ref xrc_format_type_bitmap,
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
Bitmap shown alongside the label (default: none).}
-@row3col{selected, @ref xrc_format_type_bool,
+@row3col{image, integer,
+ The zero-based index of the image associated with the item
+ into the image list.}
+@row3col{selected, @ref overview_xrcformat_type_bool,
Is the page selected initially (only one page can be selected; default: 0)?}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{buttonsize, @ref xrc_format_type_size,
+@row3col{buttonsize, @ref overview_xrcformat_type_size,
Size of the dropdown button (default: default).}
@endTable
No additional properties.
wxPanel may have optional children: either exactly one
-@ref xrc_format_sizers "sizer" child or any number of non-toplevel window
+@ref overview_xrcformat_sizers "sizer" child or any number of non-toplevel window
objects.
@beginTable
@hdr3col{property, type, description}
-@row3col{title, @ref xrc_format_type_text,
+@row3col{title, @ref overview_xrcformat_type_text,
Dialog's title (default: empty).}
-@row3col{icon, @ref xrc_format_type_bitmap,
+@row3col{icon, @ref overview_xrcformat_type_bitmap,
Dialog's icon (default: not used).}
-@row3col{centered, @ref xrc_format_type_bool,
+@row3col{centered, @ref overview_xrcformat_type_bool,
Whether the dialog should be centered on the screen (default: 0).}
-@row3col{buttons, @ref xrc_format_type_style,
+@row3col{buttons, @ref overview_xrcformat_type_style,
Buttons to show, combination of flags accepted by
wxPropertySheetDialog::CreateButtons() (default: 0).}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Sheet page's title (required).}
-@row3col{bitmap, @ref xrc_format_type_bitmap,
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
Bitmap shown alongside the label (default: none).}
-@row3col{selected, @ref xrc_format_type_bool,
+@row3col{selected, @ref overview_xrcformat_type_bool,
Is the page selected initially (only one page can be selected; default: 0)?}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Label shown on the radio button (required).}
-@row3col{value, @ref xrc_format_type_bool,
+@row3col{value, @ref overview_xrcformat_type_bool,
Initial value of the control (default: 0).}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Label for the whole box (required).}
@row3col{dimension, integer,
Specifies the maximum number of rows (if style contains
for a two-dimensional radiobox (default: 1).}
@row3col{selection, integer,
Index of the initially selected item or -1 for no selection (default: -1).}
-@row3col{content, ,
+@row3col{content, items,
Content of the control; this property has any number of @c \<item\> XML
elements as its children, with the items text as their text values
(see below; default: empty).}
@beginTable
@hdr3col{attribute, type, description}
-@row3col{tooltip, @ref xrc_format_type_string,
+@row3col{tooltip, @ref overview_xrcformat_type_string,
Tooltip to show over this ratio button (default: none).}
-@row3col{helptext, @ref xrc_format_type_string,
+@row3col{helptext, @ref overview_xrcformat_type_string,
Contextual help for this radio button (default: none).}
-@row3col{enabled, @ref xrc_format_type_bool,
+@row3col{enabled, @ref overview_xrcformat_type_bool,
Is the button enabled (default: 1)?}
-@row3col{hidden, @ref xrc_format_type_bool,
+@row3col{hidden, @ref overview_xrcformat_type_bool,
Is the button hidden initially (default: 0)?}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{value, @ref xrc_format_type_text,
+@row3col{value, @ref overview_xrcformat_type_text,
Initial value of the control (default: empty).}
@row3col{maxlength, integer,
Maximum length of the text entered (default: unlimited).}
@beginTable
@hdr3col{property, type, description}
-@row3col{scrollrate, @ref xrc_format_type_size,
+@row3col{scrollrate, @ref overview_xrcformat_type_size,
Scroll rate in @em x and @em y directions (default: not set;
required if the window has a sizer child).}
@endTable
wxScrolledWindow may have optional children: either exactly one
-@ref xrc_format_sizers "sizer" child or any number of non-toplevel window
+@ref overview_xrcformat_sizers "sizer" child or any number of non-toplevel window
objects. If sizer child is used, wxSizer::FitInside() is used (instead of
wxSizer::Fit() as usual) and so the children don't determine scrolled window's
minimal size, they only affect @em virtual size. Usually, both @c scrollrate
@beginTable
@hdr3col{property, type, description}
@row3col{value, integer,
- Initial value of the control (default: wxSL_DEFAULT_VALUE).}
+ Initial value of the control (default: 0).}
@row3col{min, integer,
- Minimum allowed value (default: wxSL_DEFAULT_MIN).}
+ Minimum allowed value (default: 0).}
@row3col{max, integer,
- Maximum allowed value (default: wxSL_DEFAULT_MAX).}
+ Maximum allowed value (default: 100).}
@row3col{pagesize, integer,
- Line size; number of steps the slider moves when the user moves
+ Page size; number of steps the slider moves when the user moves
pages up or down (default: unset).}
@row3col{linesize, integer,
Line size; number of steps the slider moves when the user moves it
@endTable
-@subsubsection xrc_wxspinctrl wxSpinCtrl
+@subsubsection xrc_wxspinbutton wxSpinButton
@beginTable
@hdr3col{property, type, description}
@row3col{value, integer,
- Initial value of the control (default: wxSP_DEFAULT_VALUE).}
+ Initial value of the control (default: 0).}
@row3col{min, integer,
- Minimum allowed value (default: wxSP_DEFAULT_MIN).}
+ Minimum allowed value (default: 0).}
@row3col{max, integer,
- Maximum allowed value (default: wxSP_DEFAULT_MAX).}
+ Maximum allowed value (default: 100).}
+@endTable
+
+
+@subsubsection xrc_wxspinctrl wxSpinCtrl
+
+wxSpinCtrl supports the same properties as @ref xrc_wxspinbutton and, since
+wxWidgets 2.9.5, another one:
+@beginTable
+@row3col{base, integer,
+ Numeric base, currently can be only 10 or 16 (default: 10).}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{orientation, @ref xrc_format_type_string,
+@row3col{orientation, @ref overview_xrcformat_type_string,
Orientation of the splitter, either "vertical" or "horizontal" (default: horizontal).}
@row3col{sashpos, integer,
Initial position of the sash (default: 0).}
@row3col{minsize, integer,
Minimum child size (default: not set).}
-@row3col{minsize, @ref xrc_format_type_float,
+@row3col{gravity, @ref overview_xrcformat_type_float,
Sash gravity, see wxSplitterWindow::SetSashGravity() (default: not set).}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{value, @ref xrc_format_type_text,
+@row3col{value, @ref overview_xrcformat_type_text,
Initial value of the control (default: empty).}
@endTable
@hdr3col{property, type, description}
@row3col{fields, integer,
Number of status bar fields (default: 1).}
-@row3col{widths, @ref xrc_format_type_string,
+@row3col{widths, @ref overview_xrcformat_type_string,
Comma-separated list of @em fields integers. Each value specifies width
of one field; the values are interpreted using the same convention used
by wxStatusBar::SetStatusWidths().}
-@row3col{styles, @ref xrc_format_type_string,
+@row3col{styles, @ref overview_xrcformat_type_string,
Comma-separated list of @em fields flags. Each value specifies status bar
fieldd style and can be one of @c wxSB_NORMAL, @c wxSB_FLAT or
@c wxSB_RAISED. See wxStatusBar::SetStatusStyles() for their description.}
@beginTable
@hdr3col{property, type, description}
-@row3col{bitmap, @ref xrc_format_type_bitmap,
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
Bitmap to display (required).}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Static box's label (required).}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Label to display (required).}
@row3col{wrap, integer,
- Number of characters per line to wrap the text for, see
+ Wrap the text so that each line is at most the given number of pixels, see
wxStaticText::Wrap() (default: no wrap).}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{value, @ref xrc_format_type_text,
+@row3col{value, @ref overview_xrcformat_type_text,
Initial value of the control (default: empty).}
@row3col{maxlength, integer,
Maximum length of the text which can be entered by user (default: unlimited).}
@endTable
-@subsubsection xrc_wxtogglebuttton wxToggleButton
+@subsubsection xrc_wxtimepickerctrl wxTimePickerCtrl
+
+No additional properties.
+
+
+@subsubsection xrc_wxtogglebutton wxToggleButton
@beginTable
@hdr3col{property, type, description}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Label to display on the button (required).}
-@row3col{checked, @ref xrc_format_type_bool,
+@row3col{checked, @ref overview_xrcformat_type_bool,
Should the button be checked/pressed initially (default: 0)?}
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{bitmapsize, @ref xrc_format_type_size,
+@row3col{bitmapsize, @ref overview_xrcformat_type_size,
Size of toolbar bitmaps (default: not set).}
-@row3col{margins, @ref xrc_format_type_size,
+@row3col{margins, @ref overview_xrcformat_type_size,
Margins (default: platform default).}
@row3col{packing, integer,
Packing, see wxToolBar::SetToolPacking() (default: not set).}
@row3col{separation, integer,
Default separator size, see wxToolBar::SetToolSeparation() (default: not set).}
-@row3col{dontattachtoframe, @ref xrc_format_type_bool,
+@row3col{dontattachtoframe, @ref overview_xrcformat_type_bool,
If set to 0 and the toolbar object is child of a wxFrame,
wxFrame::SetToolBar() is called; otherwise, you have to add it to a frame
manually. The toolbar is attached by default, you have to set this property
one of two pseudo-classes: @c separator or @c tool.
The @c separator pseudo-class is used to insert separators into the toolbar and
-has neither properties nor children.
+has neither properties nor children. Similarly, the @c space pseudo-class is
+used for stretchable spaces (see wxToolBar::AddStretchableSpace(), new since
+wxWidgets 2.9.1).
The @c tool pseudo-class objects specify toolbar buttons and have the following
properties:
@beginTable
@hdr3col{property, type, description}
-@row3col{bitmap, @ref xrc_format_type_bitmap,
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
Tool's bitmap (required).}
-@row3col{bitmap2, @ref xrc_format_type_bitmap,
+@row3col{bitmap2, @ref overview_xrcformat_type_bitmap,
Bitmap for disabled tool (default: derived from @c bitmap).}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Label to display on the tool (default: no label).}
-@row3col{radio, @ref xrc_format_type_bool,
+@row3col{radio, @ref overview_xrcformat_type_bool,
Item's kind is wxITEM_RADIO (default: 0)?}
-@row3col{toggle, @ref xrc_format_type_bool,
+@row3col{toggle, @ref overview_xrcformat_type_bool,
Item's kind is wxITEM_CHECK (default: 0)?}
-@row3col{tooltip, @ref xrc_format_type_text,
+@row3col{dropdown, see below,
+ Item's kind is wxITEM_DROPDOWN (default: 0)? (only available since wxWidgets 2.9.0)}
+@row3col{tooltip, @ref overview_xrcformat_type_text,
Tooltip to use for the tool (default: none).}
-@row3col{longhelp, @ref xrc_format_type_text,
+@row3col{longhelp, @ref overview_xrcformat_type_text,
Help text shown in statusbar when the mouse is on the tool (default: none).}
-@row3col{disabled, @ref xrc_format_type_bool,
+@row3col{disabled, @ref overview_xrcformat_type_bool,
Is the tool initially disabled (default: 0)?}
+@row3col{checked, @ref overview_xrcformat_type_bool,
+ Is the tool initially checked (default: 0)? (only available since wxWidgets 2.9.3)}
@endTable
-@c radio and @c toggle are mutually exclusive.
+The presence of a @c dropdown property indicates that the tool is of type
+wxITEM_DROPDOWN. It must be either empty or contain exactly one @ref
+xrc_wxmenu child object defining the drop-down button associated menu.
+
+Notice that @c radio, @c toggle and @c dropdown are mutually exclusive.
Children that are neither @c tool nor @c separator must be instances of classes
derived from wxControl and are added to the toolbar using
<label>Bar</label>
</object>
<object class="separator"/>
+ <object class="tool" name="view_auto">
+ <bitmap>view.png</bitmap>
+ <label>View</label>
+ <dropdown>
+ <object class="wxMenu">
+ <object class="wxMenuItem" name="view_as_text">
+ <label>View as text</label>
+ </object>
+ <object class="wxMenuItem" name="view_as_hex">
+ <label>View as binary</label>
+ </object>
+ </object>
+ </dropdown>
+ </object>
+ <object class="space"/>
<object class="wxComboBox">
<content>
<item>Just</item>
@endcode
+@subsubsection xrc_wxtoolbook wxToolbook
+
+A toolbook can have one or more child objects of the @c toolbookpage
+pseudo-class (similarly to @ref xrc_wxnotebook "wxNotebook" and its
+@c notebookpage) and one child object of the @ref xrc_wximagelist class.
+@c toolbookpage objects have the following properties:
+
+@beginTable
+@hdr3col{property, type, description}
+@row3col{label, @ref overview_xrcformat_type_text,
+ Sheet page's title (required).}
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
+ Bitmap shown alongside the label (default: none).}
+@row3col{image, integer,
+ The zero-based index of the image associated with the item
+ into the image list.}
+@row3col{selected, @ref overview_xrcformat_type_bool,
+ Is the page selected initially (only one page can be selected; default: 0)?}
+@endTable
+
+Each @c toolbookpage has exactly one non-toplevel window as its child.
+
+
@subsubsection xrc_wxtreectrl wxTreeCtrl
+A treectrl can have one child object of the @ref xrc_wximagelist class.
+
No additional properties.
@subsubsection xrc_wxtreebook wxTreebook
-No additional properties.
-
A treebook can have one or more child objects of the @c treebookpage
pseudo-class (similarly to @ref xrc_wxnotebook "wxNotebook" and its
-@c notebookpage). @c treebookpage objects have the following properties:
+@c notebookpage) and one child object of the @ref xrc_wximagelist class.
+@c treebookpage objects have the following properties:
@beginTable
@hdr3col{property, type, description}
@row3col{depth, integer,
Page's depth in the labels tree (required; see below).}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Sheet page's title (required).}
-@row3col{bitmap, @ref xrc_format_type_bitmap,
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
Bitmap shown alongside the label (default: none).}
-@row3col{selected, @ref xrc_format_type_bool,
+@row3col{image, integer,
+ The zero-based index of the image associated with the item
+ into the image list.}
+@row3col{selected, @ref overview_xrcformat_type_bool,
Is the page selected initially (only one page can be selected; default: 0)?}
+@row3col{expanded, @ref overview_xrcformat_type_bool,
+ If set to 1, the page is initially expanded. By default all pages are
+ initially collapsed.}
@endTable
Each @c treebookpage has exactly one non-toplevel window as its child.
@beginTable
@hdr3col{property, type, description}
-@row3col{bitmap, @ref xrc_format_type_bitmap,
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
Bitmap to display on the left side of the wizard (default: none).}
@endTable
A wizard object can have one or more child objects of the wxWizardPage or
wxWizardPageSimple classes. They both support the following properties
-(in addition to @ref xrc_format_std_props):
+(in addition to @ref overview_xrcformat_std_props):
@beginTable
@hdr3col{property, type, description}
-@row3col{bitmap, @ref xrc_format_type_bitmap,
+@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
Page-specific bitmap (default: none).}
@endTable
wxWizardPageSimple pages are automatically chained together; wxWizardPage pages
-transitions must be handled programatically.
+transitions must be handled programmatically.
-@section xrc_format_sizers Sizers
+@section overview_xrcformat_sizers Sizers
Sizers are handled slightly differently in XRC resources than they are in
wxWindow hierarchy. wxWindow's sizers hierarchy is parallel to the wxWindow
-children hieararchy: child windows are children of their parent window and
+children hierarchy: child windows are children of their parent window and
the sizer (or sizers) form separate hierarchy attached to the window with
wxWindow::SetSizer().
toplevel window, wxSizer::SetSizeHints() is called to set its hints.
A sizer object can have one or more child objects of one of two pseudo-classes:
-@c sizeritem or @c spacer (see @ref xrc_format_wxstddialogbuttonsizer for
+@c sizeritem or @c spacer (see @ref overview_xrcformat_wxstddialogbuttonsizer for
an exception). The former specifies an element (another sizer or a window)
to include in the sizer, the latter adds empty space to the sizer.
@beginTable
@hdr3col{property, type, description}
-@row3col{size, @ref xrc_format_type_size, Size of the empty space (required).}
+@row3col{size, @ref overview_xrcformat_type_size, Size of the empty space (required).}
@endTable
Both @c sizeritem and @c spacer objects can have any of the following
@row3col{option, integer,
The "option" value for sizers. Used by wxBoxSizer to set proportion of
the item in the growable direction (default: 0).}
-@row3col{flag, @ref xrc_format_type_style,
+@row3col{flag, @ref overview_xrcformat_type_style,
wxSizerItem flags (default: 0).}
-@row3col{border, @ref xrc_format_type_dimension,
+@row3col{border, @ref overview_xrcformat_type_dimension,
Size of the border around the item (directions are specified in flags)
(default: 0).}
-@row3col{minsize, @ref xrc_format_type_size,
+@row3col{minsize, @ref overview_xrcformat_type_size,
Minimal size of this item (default: no min size).}
-@row3col{ratio, @ref xrc_format_type_size,
+@row3col{ratio, @ref overview_xrcformat_type_size,
Item ratio, see wxSizer::SetRatio() (default: no ratio).}
-@row3col{cellpos, @ref xrc_format_type_pos,
+@row3col{cellpos, @ref overview_xrcformat_type_pos,
(wxGridBagSizer only) Position, see wxGBSizerItem::SetPos() (required). }
-@row3col{cellspan, @ref xrc_format_type_size,
+@row3col{cellspan, @ref overview_xrcformat_type_size,
(wxGridBagSizer only) Span, see wxGBSizerItem::SetSpan() (required). }
@endTable
@beginTable
@hdr3col{property, type, description}
-@row3col{minsize, @ref xrc_format_type_size,
+@row3col{minsize, @ref overview_xrcformat_type_size,
Minimal size that this sizer will have, see wxSizer::SetMinSize()
(default: no min size).}
@endTable
-@subsection xrc_format_wxboxsizer wxBoxSizer
+@subsection overview_xrcformat_wxboxsizer wxBoxSizer
@beginTable
@hdr3col{property, type, description}
-@row3col{orient, @ref xrc_format_type_style,
+@row3col{orient, @ref overview_xrcformat_type_style,
Sizer orientation, "wxHORIZONTAL" or "wxVERTICAL" (default: wxHORIZONTAL).}
@endTable
-@subsection xrc_format_wxstaticsboxizer wxStaticBoxSizer
+@subsection overview_xrcformat_wxstaticsboxizer wxStaticBoxSizer
@beginTable
@hdr3col{property, type, description}
-@row3col{orient, @ref xrc_format_type_style,
+@row3col{orient, @ref overview_xrcformat_type_style,
Sizer orientation, "wxHORIZONTAL" or "wxVERTICAL" (default: wxHORIZONTAL).}
-@row3col{label, @ref xrc_format_type_text,
+@row3col{label, @ref overview_xrcformat_type_text,
Label to be used for the static box around the sizer (required).}
@endTable
-@subsection xrc_format_wxgridsizer wxGridSizer
+@subsection overview_xrcformat_wxgridsizer wxGridSizer
@beginTable
@hdr3col{property, type, description}
-@row3col{rows, integer, Number of rows in the grid (required).}
-@row3col{cols, integer, Number of columns in the grid (required).}
+@row3col{rows, integer, Number of rows in the grid (default: 0 - determine automatically).}
+@row3col{cols, integer, Number of columns in the grid (default: 0 - determine automatically).}
@row3col{vgap, integer, Vertical gap between children (default: 0).}
@row3col{hgap, integer, Horizontal gap between children (default: 0).}
@endTable
-@subsection xrc_format_wxflexgridsizer wxFlexGridSizer
+@subsection overview_xrcformat_wxflexgridsizer wxFlexGridSizer
@beginTable
@hdr3col{property, type, description}
-@row3col{rows, integer, Number of rows in the grid (required).}
-@row3col{cols, integer, Number of columns in the grid (required).}
+@row3col{rows, integer, Number of rows in the grid (default: 0 - determine automatically).}
+@row3col{cols, integer, Number of columns in the grid (default: 0 - determine automatically).}
@row3col{vgap, integer, Vertical gap between children (default: 0).}
@row3col{hgap, integer, Horizontal gap between children (default: 0).}
@row3col{growablerows, comma-separated integers list,
(default: none).}
@endTable
-@subsection xrc_format_wxgridbagsizer wxGridBagSizer
+@subsection overview_xrcformat_wxgridbagsizer wxGridBagSizer
@beginTable
@hdr3col{property, type, description}
(default: none).}
@endTable
-@subsection xrc_format_wxwrapsizer wxWrapSizer
+@subsection overview_xrcformat_wxwrapsizer wxWrapSizer
@beginTable
@hdr3col{property, type, description}
-@row3col{orient, @ref xrc_format_type_style,
+@row3col{orient, @ref overview_xrcformat_type_style,
Sizer orientation, "wxHORIZONTAL" or "wxVERTICAL" (required).}
-@row3col{flag, @ref xrc_format_type_style, wxWrapSizer flags (default: 0).}
+@row3col{flag, @ref overview_xrcformat_type_style, wxWrapSizer flags (default: 0).}
@endTable
-@subsection xrc_format_wxstddialogbuttonsizer wxStdDialogButtonSizer
+@subsection overview_xrcformat_wxstddialogbuttonsizer wxStdDialogButtonSizer
-Unlike other sizers, wxStdDialogButtonSizer doesn't have neither @c sizeritem
+Unlike other sizers, wxStdDialogButtonSizer has neither @c sizeritem
nor @c spacer children. Instead, it has one or more children of the
@c button pseudo-class. @c button objects have no properties and they must
always have exactly one child of the @c wxButton class or a class derived from
-@section xrc_format_other_objects Other objects
+@section overview_xrcformat_other_objects Other Objects
In addition to describing UI elements, XRC files can contain non-windows
objects such as bitmaps or icons. This is a concession to Windows developers
embedded in the XRC file itself. XRC file only contains a reference to another
file with bitmap data.
-@subsection xrc_format_bitmap wxBitmap
+@subsection overview_xrcformat_bitmap wxBitmap
Bitmaps are stored in @c \<object\> element with class set to @c wxBitmap. Such
bitmaps can then be loaded using wxXmlResource::LoadBitmap(). The content of
the element is exactly same as in the case of
-@ref xrc_format_type_bitmap "bitmap properties", except that toplevel
+@ref overview_xrcformat_type_bitmap "bitmap properties", except that toplevel
@c \<object\> is used.
For example, instead of:
@endcode
-@subsection xrc_format_icon wxIcon
+@subsection overview_xrcformat_icon wxIcon
-wxIcon resources are identical to @ref xrc_format_bitmap "wxBitmap ones",
+wxIcon resources are identical to @ref overview_xrcformat_bitmap "wxBitmap ones",
except that the class is @c wxIcon.
-@section xrc_format_platform Platform specific content
+@section overview_xrcformat_platform Platform Specific Content
It is possible to conditionally process parts of XRC files on some platforms
only and ignore them on other platforms. @em Any element in XRC file, be it
Possible elemental values are:
@beginDefList
@itemdef{ @c win, Windows }
-@itemdef{ @c mac, Mac OS X (or Mac Classic in wxWidgets version supporting it }
+@itemdef{ @c mac, Mac OS X (or Mac Classic in wxWidgets version supporting it) }
@itemdef{ @c unix, Any Unix platform @em except OS X }
@itemdef{ @c os2, OS/2 }
@endDefList
-@section xrc_format_extending Extending XRC format
+@section overview_xrcformat_idranges ID Ranges
+
+Usually you won't care what value the XRCID macro returns for the ID of an
+object. Sometimes though it is convenient to have a range of IDs that are
+guaranteed to be consecutive. An example of this would be connecting a group of
+similar controls to the same event handler.
+
+The following XRC fragment 'declares' an ID range called @em foo and another
+called @em bar; each with some items.
+
+@code
+ <object class="wxButton" name="foo[start]">
+ <object class="wxButton" name="foo[end]">
+ <object class="wxButton" name="foo[2]">
+ ...
+ <object class="wxButton" name="bar[0]">
+ <object class="wxButton" name="bar[2]">
+ <object class="wxButton" name="bar[1]">
+ ...
+<ids-range name="foo" />
+<ids-range name="bar" size="30" start="10000" />
+@endcode
+
+For the range foo, no @em size or @em start parameters were given, so the size
+will be calculated from the number of range items, and IDs allocated by
+wxWindow::NewControlId (so they'll be negative). Range bar asked for a size of
+30, so this will be its minimum size: should it have more items, the range will
+automatically expand to fit them. It specified a start ID of 10000, so
+XRCID("bar[0]") will be 10000, XRCID("bar[1]") 10001 etc. Note that if you
+choose to supply a start value it must be positive, and it's your
+responsibility to avoid clashes.
+
+For every ID range, the first item can be referenced either as
+<em>rangename</em>[0] or <em>rangename</em>[start]. Similarly
+<em>rangename</em>[end] is the last item. Using [start] and [end] is more
+descriptive in e.g. a Bind() event range or a @em for loop, and they don't have
+to be altered whenever the number of items changes.
+
+Whether a range has positive or negative IDs, [start] is always a smaller
+number than [end]; so code like this works as expected:
+
+@code
+for (int n=XRCID("foo[start]"); n <= XRCID("foo[end]"); ++n)
+ ...
+@endcode
+
+ID ranges can be seen in action in the <em>objref</em> dialog section of the
+@sample{xrc}.
+
+@note
+@li All the items in an ID range must be contained in the same XRC file.
+@li You can't use an ID range in a situation where static initialisation
+occurs; in particular, they won't work as expected in an event table. This is
+because the event table's IDs are set to their integer values before the XRC
+file is loaded, and aren't subsequently altered when the XRCID value changes.
+
+@since 2.9.2
+
+@section overview_xrcformat_extending Extending the XRC Format
The XRC format is designed to be extensible and allows specifying and loading
custom controls. The three available mechanisms are described in the rest of
this section in the order of increasing complexity.
-@subsection xrc_format_extending_subclass Subclassing
+@subsection overview_xrcformat_extending_subclass Subclassing
The simplest way to add custom controls is to set the @c subclass attribute
of @c \<object\> element:
must not be customized.
-@subsection xrc_format_extending_unknown <object class="unknown">
+@subsection overview_xrcformat_extending_unknown Unknown Objects
A more flexible solution is to put a @em placeholder in the XRC file and
replace it with custom control after the resource is loaded. This is done by
This method makes it possible to insert controls that are not known to XRC at
all, but it's also impossible to configure the control in XRC description in
any way. The only properties that can be specified are
-the @ref xrc_format_std_props "standard window properties".
+the @ref overview_xrcformat_std_props "standard window properties".
@note @c unknown class cannot be combined with @c subclass attribute,
they are mutually exclusive.
-@subsection xrc_format_extending_custom Adding custom classes
+@subsection overview_xrcformat_extending_custom Adding Custom Classes
Finally, XRC allows adding completely new classes in addition to the ones
listed in this document. A class for which wxXmlResourceHandler is implemented
no limitations on them imposed by XRC format.
This is the only mechanism that works for toplevel objects -- custom controls
-are accessible using type-unsafe wxXmlResource::LoadObject() method.
+are accessible using the type-unsafe wxXmlResource::LoadObject() method.
-@section xrc_format_packed Packed XRC files
+@section overview_xrcformat_packed Packed XRC Files
In addition to plain XRC files, wxXmlResource supports (if wxFileSystem support
is compiled in) compressed XRC resources. Compressed resources have either
-@section xrc_format_oldversions Older format versions
+@section overview_xrcformat_oldversions Older Format Versions
This section describes differences in older revisions of XRC format (i.e.
files with older values of @c version attribute of @c \<resource\>).
-@subsection xrc_format_pre_v2530 Versions before 2.5.3.0
+@subsection overview_xrcformat_pre_v2530 Versions Before 2.5.3.0
Version 2.5.3.0 introduced C-like handling of "\\" in text. In older versions,
"\n", "\t" and "\r" escape sequences were replaced with respective characters
them are handled in C-like manner.
-@subsection xrc_format_pre_v2301 Versions before 2.3.0.1
+@subsection overview_xrcformat_pre_v2301 Versions Before 2.3.0.1
Prior to version 2.3.0.1, "$" was used for accelerators instead of "_"
or "&". For example,
projects / wxWidgets.git / blobdiff