X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a302d5958c111a6fe3dbdbc7718cc0f8188fced6..e87d78bb36f371d593137761158118fb09b69fa2:/docs/doxygen/overviews/xrc_format.h diff --git a/docs/doxygen/overviews/xrc_format.h b/docs/doxygen/overviews/xrc_format.h index bc37040f15..80f0388adf 100644 --- a/docs/doxygen/overviews/xrc_format.h +++ b/docs/doxygen/overviews/xrc_format.h @@ -3,39 +3,26 @@ // Purpose: XRC format specification // Author: Vaclav Slavik // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// + +/* + NOTE: To make doxygen happy about 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 - -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 +@page overview_xrcformat XRC File Format + +@tableofcontents This document describes the format of XRC resource files, as used by wxXmlResource. - -@section xrc_format_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, @c http://www.wxwindows.org/wxxrc namespace is accepted as well (and treated @@ -46,18 +33,19 @@ XRC file contains definitions for one or more @em objects -- typically 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: -The root element is always @c . It has one optional attribute, @c +@section overview_xrcformat_root Resource Root Element + +The root element is always @c \. It has one optional attribute, @c version. If set, it specifies version of the file. In absence of @c version attribute, the default is @c "0.0.0.0". @@ -80,19 +68,19 @@ specified to take advantage of the latest capabilities: @endcode -@c may have arbitrary number of -@ref xrc_format_objects "object elements" as its children; they are referred +@c \ may have arbitrary number of +@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 +@subsection overview_xrcformat_object Object Element -The @c element represents a single object (typically a GUI element) +The @c \ element represents a single object (typically a GUI element) and it usually maps directly to a wxWidgets class instance. It has one mandatory attribute, @c class, and optional @c name and @c subclass attributes. @@ -118,22 +106,22 @@ toplevel window (wxDialog, wxFrame). 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 element may -- and almost always do -- have children elements. +@c \ 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 - ("