Source cleaning, wxW headers, whitespaces and improved PCH support.

[wxWidgets.git] / docs / tech / tn0014.txt

diff --git a/docs/tech/tn0014.txt b/docs/tech/tn0014.txt
index 467371a0bed151bb56eb1dd8209392567c24722f..57d73456b660499dca7269f78a2190278f772da3 100644 (file)
--- a/docs/tech/tn0014.txt
+++ b/docs/tech/tn0014.txt
@@ -13,8 +13,10 @@ dialog editors with XRC support.
 If you only want to use the resources, you can choose from a number of editors:
   a) wxDesigner (http://www.roebling.de)
   b) XRCed (wxPython/tools)
 If you only want to use the resources, you can choose from a number of editors:
   a) wxDesigner (http://www.roebling.de)
   b) XRCed (wxPython/tools)

-  c) wxWorkshop (http://wxworkshop.sf.net)
-  b) wxrcedit (contrib/utils/wxrcedit)
+  c) DialogBlocks (wxPython/tools)
+
+and others listed on the Resources section of the wxWidgets web
+site.

 
 The XRC format is based on XML 1.0 (please consult W3C's specification). There
 is no DTD available since it is not possible to fully describe the format with
 
 The XRC format is based on XML 1.0 (please consult W3C's specification). There
 is no DTD available since it is not possible to fully describe the format with


@@ -28,14 +30,14 @@ Note: see also http://ldaptool.sourceforge.net/XRCGuide/XRCGuideSingle/
 1. Terminology
 ==============
 
 1. Terminology
 ==============
 

-The usual XML terminology applies. In particular, we shall use the terms 
+The usual XML terminology applies. In particular, we shall use the terms

 NODE, PROPERTY and VALUE in the XML sense:
 
     <node property1="value1" property2="value2">...</node>
 
 NODE, PROPERTY and VALUE in the XML sense:
 
     <node property1="value1" property2="value2">...</node>
 

-The term ATTRIBUTE is specific to XRC and refers to a subnode 
-of an <object> or <object_ref> node that is itself not <object> or <object_ref>. 
-In the example below, <pos>, <label> and <style> are attributes, while neither 
+The term ATTRIBUTE is specific to XRC and refers to a subnode
+of an <object> or <object_ref> node that is itself not <object> or <object_ref>.
+In the example below, <pos>, <label> and <style> are attributes, while neither

 <resource> nor either of <object>s is:
 
     <?xml version="1.0" encoding="utf-8">
 <resource> nor either of <object>s is:
 
     <?xml version="1.0" encoding="utf-8">


@@ -60,17 +62,17 @@ can think of it as attribute value syntax definition).
 =========================
 
 XRC resource file is a well-formed XML 1.0 document. All elements of XRC file
 =========================
 
 XRC resource file is a well-formed XML 1.0 document. All elements of XRC file

-are from the http://www.wxwidgets.org/wxxrc namespace. 
+are from the http://www.wxwidgets.org/wxxrc namespace.

 
 

-The root node of XRC document must be <resource>. The <resource> node has 
-optional "version" property. Default version  (in absence of the version 
-property) is "0.0.0.0". The version consists of four integers separated by 
-periods. Version of XRC format changes only if there was an incompatible 
-change introduced (i.e. either the library cannot understand old resource 
+The root node of XRC document must be <resource>. The <resource> node has
+optional "version" property. Default version  (in absence of the version
+property) is "0.0.0.0". The version consists of four integers separated by
+periods. Version of XRC format changes only if there was an incompatible
+change introduced (i.e. either the library cannot understand old resource

 files or older versions of the library wouldn't understand the new format).
 files or older versions of the library wouldn't understand the new format).

-The first three integers are major, minor and release number of the wxWidgets 
-release when the change was introduced, the last one is revision number and 
-is 0 for the first incompatible change in given wxWidgets release, 1 for 
+The first three integers are major, minor and release number of the wxWidgets
+release when the change was introduced, the last one is revision number and
+is 0 for the first incompatible change in given wxWidgets release, 1 for

 the second etc.
 
 Differences between versions are described within this document in paragraphs
 the second etc.
 
 Differences between versions are described within this document in paragraphs


@@ -84,7 +86,7 @@ The <resource> node is only allowed to have <object> and <object_ref>
 subnodes, all of which must have the "name" property.
 
 The <object> node represents a single object (GUI element) and it usually maps
 subnodes, all of which must have the "name" property.
 
 The <object> node represents a single object (GUI element) and it usually maps

-directly to a wxWidgets class instance. It three properties: "name", "class"
+directly to a wxWidgets class instance. It has the properties: "name", "class"

 and "subclass". "class" must always be present, it tells XRC what wxWidgets
 object should be created in this place. The other two are optional.  "name" is
 ID used to identify the object. It is the value passed to the XRCID() macro and
 and "subclass". "class" must always be present, it tells XRC what wxWidgets
 object should be created in this place. The other two are optional.  "name" is
 ID used to identify the object. It is the value passed to the XRCID() macro and


@@ -97,19 +99,24 @@ constructor for "class". Subclass must be available in the program that loads
 the resource, must be derived from "class" and must be registered within
 wxWidgets' RTTI system.
 
 the resource, must be derived from "class" and must be registered within
 wxWidgets' RTTI system.
 

+Finally, an optional "insert_at" property may be present. Currently only the
+values "begin" and "end" are supported, meaning to insert the object in the
+beginning of the parent node objects list or to append it at the end (which is
+the default if this property is absent).
+

 Example:
 
     <object name="MyList1" class="wxListCtrl" subclass="MyListCtrlClass">
         ...
 Example:
 
     <object name="MyList1" class="wxListCtrl" subclass="MyListCtrlClass">
         ...

-    </object>    
-    
+    </object>
+

 <object> node may have arbitrary child nodes. What child nodes and their
 semantics are class-dependent and are defined later in this document. The user
 is allowed to register new object handlers within XRC and extend it to accept
 new <object> classes (and therefore different <object>'s child nodes).
 
 <object_ref> node is identical to <object>, except that it does _not_ have
 <object> node may have arbitrary child nodes. What child nodes and their
 semantics are class-dependent and are defined later in this document. The user
 is allowed to register new object handlers within XRC and extend it to accept
 new <object> classes (and therefore different <object>'s child nodes).
 
 <object_ref> node is identical to <object>, except that it does _not_ have

-"class" property and has additional required property "ref". It's concept is
+"class" property and has additional required property "ref". Its concept is

 similar to Unix symlinks: value of the "ref" property is equal to the value of
 "name" property of some existing node (called referred node) in the resources
 (not necessary top-level).  Referred node's "class" property and all subnodes
 similar to Unix symlinks: value of the "ref" property is equal to the value of
 "name" property of some existing node (called referred node) in the resources
 (not necessary top-level).  Referred node's "class" property and all subnodes


@@ -127,7 +134,7 @@ Example:
         <value>bar</value>               <!-- override! -->
     </object_ref>
 
         <value>bar</value>               <!-- override! -->
     </object_ref>
 

-is identical to:    
+is identical to:

 
     <object name="foo" class="wxTextCtrl">
         <value>hello</value>
 
     <object name="foo" class="wxTextCtrl">
         <value>hello</value>


@@ -213,7 +220,7 @@ define own constants, effectively any string is legal here). Examples are
 "wxART_FILE_OPEN" (id) or "wxART_MENU" (client).
 
 Any of "stock_id" or "stock_client" properties or the filename may be omitted.
 "wxART_FILE_OPEN" (id) or "wxART_MENU" (client).
 
 Any of "stock_id" or "stock_client" properties or the filename may be omitted.

-XRC determines the bitmap to use according to this algorithm: 
+XRC determines the bitmap to use according to this algorithm:

   1. If there is non-empty "stock_id" property, query wxArtProvider for the
      bitmap (if there is no "stock_client", use default one, which is usually
      wxART_OTHER; exceptions are noted in class-specific sections below). If
   1. If there is non-empty "stock_id" property, query wxArtProvider for the
      bitmap (if there is no "stock_client", use default one, which is usually
      wxART_OTHER; exceptions are noted in class-specific sections below). If


@@ -249,12 +256,12 @@ relativesize    Float, font size relative to choosen system font's size;
 All of them are optional, if they are missing, wxFont default is used.
 
 Examples:
 All of them are optional, if they are missing, wxFont default is used.
 
 Examples:

-    
+

     <font>
         <face>arial,helvetica</face>
         <size>12</size>
     </font>
     <font>
         <face>arial,helvetica</face>
         <size>12</size>
     </font>

-    
+

     <font>
         <sysfont>wxSYS_DEFAULT_GUI_FONT</sysfont>
         <weight>bold</weight>
     <font>
         <sysfont>wxSYS_DEFAULT_GUI_FONT</sysfont>
         <weight>bold</weight>


@@ -284,9 +291,23 @@ attribute name             attribute type          default value, if any
                            [(optional remarks....................
                            ...................................)]
 
                            [(optional remarks....................
                            ...................................)]
 

+Common attributes
+-----------------
+These attributes are supported by all windows:
+
+exstyle                    Int
+bg                         Colour
+fg                         Colour
+enabled                    Boolean                 true
+focused                    Boolean                 false
+hidden                     Boolean                 false
+tooltip                    I18nString
+font                       Font
+help                       I18nString
+

 wxBitmap
 --------
 wxBitmap
 --------

-This is a special case, because it does not create a wxWindow instance but 
+This is a special case, because it does not create a wxWindow instance but

 creates wxBitmap instead. Another exceptional thing is that it does not have
 any attributes. Instead, the node itself is interpreted as if it were attribute
 of type Bitmap.
 creates wxBitmap instead. Another exceptional thing is that it does not have
 any attributes. Instead, the node itself is interpreted as if it were attribute
 of type Bitmap.


@@ -303,7 +324,7 @@ wxButton
 --------
 pos                        Position                -1,-1
 size                       Size                    -1,-1
 --------
 pos                        Position                -1,-1
 size                       Size                    -1,-1

-style                      Style[wxButton]    
+style                      Style[wxButton]

 
 label                      I18nString
 default                    Boolean                 false
 
 label                      I18nString
 default                    Boolean                 false


@@ -350,6 +371,13 @@ Example:
 </object>
 
 
 </object>
 
 

+wxDatePickerCtrl
+----------------
+pos                        Position                -1,-1
+size                       Size                    -1,-1
+style                      Style[wxDatePickerCtrl]
+
+

 wxDialog
 --------
 pos                        Position                -1,-1
 wxDialog
 --------
 pos                        Position                -1,-1


@@ -376,6 +404,28 @@ wxMenuBar and wxStatusBar children; objects of these types are automatically
 set as frame's tool-, menu- and statusbar respectively.
 
 
 set as frame's tool-, menu- and statusbar respectively.
 
 

+wxMDIParentFrame
+----------------
+
+Supports same attributes and children nodes as wxFrame. Additionally, children
+may be of the wxMDIChildFrame type.
+
+
+wxMDIChildFrame
+---------------
+
+Supports same attributes and children nodes as wxFrame.
+
+
+wxRadioBox
+----------
+
+This control may have "dimension" (major dimension) and (initial) "selection"
+Integer subelements and a composite "content" element similar to wxCheckList.
+The only difference is that the "item" subelements can have an optional
+"tooltip=I18nString" attribute to specify the per-item tooltip.
+
+

 wxScrolledWindow
 ----------------
 pos                        Position                -1,-1
 wxScrolledWindow
 ----------------
 pos                        Position                -1,-1


@@ -419,6 +469,8 @@ bitmapsize                 Size                    -1,-1
 margins                    Size                    -1,-1
 packing                    Integer                 -1
 separation                 Integer                 -1
 margins                    Size                    -1,-1
 packing                    Integer                 -1
 separation                 Integer                 -1

+bg                         Background colour       None
+dontattachtoframe          Boolean                 False

 
 wxToolBar node may have children <object> and <object_ref> nodes. Their class
 may be either "tool", "separator" or any wxWidgets class derived from
 
 wxToolBar node may have children <object> and <object_ref> nodes. Their class
 may be either "tool", "separator" or any wxWidgets class derived from


@@ -431,10 +483,11 @@ appear within wxToolBar node. Their attributes are as follows:
 
     tool
     ----
 
     tool
     ----

-    bitmap                 Bitmap                  
+    bitmap                 Bitmap

     bitmap2                Bitmap                  wxNullBitmap
     toggle                 Boolean                 0
     radio                  Boolean                 0
     bitmap2                Bitmap                  wxNullBitmap
     toggle                 Boolean                 0
     radio                  Boolean                 0

+    disabled               Boolean                 0

     label                  I18nString              ""
     tooltip                I18nString              ""
     longhelp               I18nString              ""
     label                  I18nString              ""
     tooltip                I18nString              ""
     longhelp               I18nString              ""


@@ -444,7 +497,7 @@ appear within wxToolBar node. Their attributes are as follows:
       At most one of "toggle" and "radio" attributes may be 1.
       Attribute "pos" may not appear if "label" or "radio" attributes
       are used or if parent wxToolBar's style contains wxTB_TEXT.
       At most one of "toggle" and "radio" attributes may be 1.
       Attribute "pos" may not appear if "label" or "radio" attributes
       are used or if parent wxToolBar's style contains wxTB_TEXT.

-    
+

     Note:
       Use of "pos" attribute is strongly discouraged, it is deprecated
       usage of wxToolBar and it is not supported by MSW and GTK
     Note:
       Use of "pos" attribute is strongly discouraged, it is deprecated
       usage of wxToolBar and it is not supported by MSW and GTK