Use UTF16 for text data object on Mac. Fixes #10902

[wxWidgets.git] / docs / doxygen / overviews / xrc_format.h

diff --git a/docs/doxygen/overviews/xrc_format.h b/docs/doxygen/overviews/xrc_format.h
index bc07cb0c45589c874e9ff1cb0545a475f15c222d..00adb8849bb4f442234fbe16d6ace202d86f324b 100644 (file)
--- a/docs/doxygen/overviews/xrc_format.h
+++ b/docs/doxygen/overviews/xrc_format.h
@@ -136,7 +136,7 @@ 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
  -# 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.
+    ("\<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
     @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


@@ -482,8 +482,14 @@ from properties lists below.
     (default: not set).}
 @row3col{fg, @ref overview_xrcformat_type_colour,
     Foreground colour of the window (default: window's default).}
     (default: not set).}
 @row3col{fg, @ref overview_xrcformat_type_colour,
     Foreground colour of the window (default: window's default).}

+@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{bg, @ref overview_xrcformat_type_colour,
     Background colour of the window (default: window's default).}

+@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 overview_xrcformat_type_bool,
 @row3col{enabled, @ref overview_xrcformat_type_bool,
     If set to 0, the control is disabled (default: 1).}
 @row3col{hidden, @ref overview_xrcformat_type_bool,


@@ -492,6 +498,9 @@ from properties lists below.
     Tooltip to use for the control (default: not set).}
 @row3col{font, @ref overview_xrcformat_type_font,
     Font to use for the control (default: window's default).}
     Tooltip to use for the control (default: not set).}
 @row3col{font, @ref overview_xrcformat_type_font,
     Font to use for the control (default: window's default).}

+@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).}
 @row3col{help, @ref overview_xrcformat_type_text,
     Context-sensitive help for the control, used by wxHelpProvider
     (default: not set).}


@@ -581,9 +590,13 @@ Example:
 @beginTable
 @hdr3col{property, type, description}
 @row3col{label, @ref overview_xrcformat_type_text,
 @beginTable
 @hdr3col{property, type, description}
 @row3col{label, @ref overview_xrcformat_type_text,

-     Label to display on the button (required).}
+    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,
 @row3col{default, @ref overview_xrcformat_type_bool,

-     Should this button be the default button in dialog (default: 0)?}
+    Should this button be the default button in dialog (default: 0)?}

 @endTable
 
 
 @endTable
 
 


@@ -771,6 +784,20 @@ objects. If sizer child is used, it sets
 @endTable
 
 
 @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
 @subsubsection xrc_wxfilepickerctrl wxFilePickerCtrl
 
 @beginTable


@@ -780,7 +807,8 @@ objects. If sizer child is used, it sets
 @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,
 @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,

-    Message shown to the user in wxDirDialog shown by the control (required).}
+    Sets the wildcard, which can contain multiple file types, for example:
+    "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".}

 @endTable
 
 
 @endTable
 
 


@@ -959,13 +987,36 @@ Each @c listbookpage has exactly one non-toplevel window as its child.
 
 @subsubsection xrc_wxlistctrl wxListCtrl
 
 
 @subsubsection xrc_wxlistctrl wxListCtrl
 

-A listctrl can have one or more child objects of the class @ref xrc_wxlistitem
+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.
 
 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.
 

-@subsubsection xrc_wxlistitem wxListItem
+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. }
+@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:
 
 The @c listitem is a child object for the class @ref xrc_wxlistctrl.
 It can have the following properties:


@@ -986,14 +1037,14 @@ It can have the following properties:
     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.}
     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{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{col, integer,
-    The zero-based column index.}

 @row3col{data, integer,
     The client data for the item.}
 @row3col{font, @ref overview_xrcformat_type_font,
 @row3col{data, integer,
     The client data for the item.}
 @row3col{font, @ref overview_xrcformat_type_font,


@@ -1001,33 +1052,14 @@ It can have the following properties:
 @row3col{image, integer,
     The zero-based index of the image associated with the item
     into the image list.}
 @row3col{image, integer,
     The zero-based index of the image associated with the item
     into the image list.}

-@row3col{mask, @ref overview_xrcformat_type_style,
-    The mask indicating which fields of this class are valid.
-    Can be any combination of the following values:
-        - wxLIST_MASK_STATE: @b GetState is valid.
-        - wxLIST_MASK_TEXT: @b GetText is valid.
-        - wxLIST_MASK_IMAGE: @b GetImage is valid.
-        - wxLIST_MASK_DATA: @b GetData is valid.
-        - wxLIST_MASK_WIDTH: @b GetWidth is valid.
-        - wxLIST_MASK_FORMAT: @b GetFormat is valid. }

 @row3col{state, @ref overview_xrcformat_type_style,
 @row3col{state, @ref overview_xrcformat_type_style,

-    The item state flags (note that the valid state flags are influenced
-    by the value of the @c statemask, see below).
-    Can be any combination of the following values:
+    The item state. Can be any combination of the following values:

         - @c wxLIST_STATE_FOCUSED: The item has the focus.
         - @c wxLIST_STATE_FOCUSED: The item has the focus.

-        - @c wxLIST_STATE_SELECTED: The item is selected.
-        - @c wxLIST_STATE_DONTCARE: Don't care what the state is. Win32 only.
-        - @c wxLIST_STATE_DROPHILITED: The item is highlighted to receive a drop event. Win32 only.
-        - @c wxLIST_STATE_CUT: The item is in the cut state. Win32 only. }
-@row3col{statemask, bitlist,
-    A mask indicating which state flags are valid. This is a bitlist of the
-    flags reported above for the item state. }
+        - @c wxLIST_STATE_SELECTED: The item is selected.}

 @row3col{text, @ref overview_xrcformat_type_string,
 @row3col{text, @ref overview_xrcformat_type_string,

-    The text label (or header for columns) for the item. }
+    The text label for the item. }

 @row3col{textcolour, @ref overview_xrcformat_type_colour,
     The text colour for the item. }
 @row3col{textcolour, @ref overview_xrcformat_type_colour,
     The text colour for the item. }

-@row3col{width, integer,
-    The column width. }

 @endTable
 
 Notice that the item position can't be specified here, the items are appended
 @endTable
 
 Notice that the item position can't be specified here, the items are appended


@@ -1424,7 +1456,7 @@ wxSpinCtrl supports the properties as @ref xrc_wxspinbutton.
     Initial position of the sash (default: 0).}
 @row3col{minsize, integer,
     Minimum child size (default: not set).}
     Initial position of the sash (default: 0).}
 @row3col{minsize, integer,
     Minimum child size (default: not set).}

-@row3col{minsize, @ref overview_xrcformat_type_float,
+@row3col{gravity, @ref overview_xrcformat_type_float,

     Sash gravity, see wxSplitterWindow::SetSashGravity() (default: not set).}
 @endTable
 
     Sash gravity, see wxSplitterWindow::SetSashGravity() (default: not set).}
 @endTable
 


@@ -1490,7 +1522,7 @@ No additional properties.
 @row3col{label, @ref overview_xrcformat_type_text,
      Label to display (required).}
 @row3col{wrap, integer,
 @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
 
      wxStaticText::Wrap() (default: no wrap).}
 @endTable