More doxygen topic overview cleanup.

[wxWidgets.git] / docs / latex / wx / xmlres.tex

diff --git a/docs/latex/wx/xmlres.tex b/docs/latex/wx/xmlres.tex
index 7ef4cf75df44eff07eb5d9069594930854261cd3..9a5488d2e796e3399f09434a2978413e312bb7dd 100644 (file)
--- a/docs/latex/wx/xmlres.tex
+++ b/docs/latex/wx/xmlres.tex
@@ -19,6 +19,10 @@ See \helpref{XML-based resource system overview}{xrcoverview} for details.
 
 <wx/xrc/xmlres.h>
 
 
 <wx/xrc/xmlres.h>
 

+\wxheading{Library}
+
+\helpref{wxXrc}{librarieslist}
+

 \wxheading{Constants}
 
 \begin{verbatim}
 \wxheading{Constants}
 
 \begin{verbatim}


@@ -35,7 +39,9 @@ enum wxXmlResourceFlags
 
 \membersection{wxXmlResource::wxXmlResource}\label{wxxmlresourcector}
 
 
 \membersection{wxXmlResource::wxXmlResource}\label{wxxmlresourcector}
 

-\func{}{wxXmlResource}{\param{const wxString\& }{filemask}, \param{int }{flags = wxXRC\_USE\_LOCALE}}
+\func{}{wxXmlResource}{\param{const wxString\& }{filemask}, 
+    \param{int }{flags = wxXRC\_USE\_LOCALE},
+    \param{const wxString& }{domain = wxEmptyString}}

 
 Constructor.
 
 
 Constructor.
 


@@ -46,7 +52,13 @@ load all resource files inside a zip archive.}
 wxXRC\_NO\_SUBCLASSING: subclass property of object nodes will be ignored
 (useful for previews in XRC editors).}
 
 wxXRC\_NO\_SUBCLASSING: subclass property of object nodes will be ignored
 (useful for previews in XRC editors).}
 

-\func{}{wxXmlResource}{\param{int }{flags = wxXRC\_USE\_LOCALE}}
+\docparam{domain}{The name of the gettext catalog to search for
+  translatable strings.  By default all loaded catalogs will be
+  searched.  This provides a way to allow the strings to only come
+  from a specific catalog.}
+
+\func{}{wxXmlResource}{\param{int }{flags = wxXRC\_USE\_LOCALE},
+    \param{const wxString& }{domain = wxEmptyString}}

 
 Constructor.
 
 
 Constructor.
 


@@ -56,6 +68,11 @@ wxXRC\_NO\_SUBCLASSING: subclass property of object nodes will be ignored
 XRC files from being reloaded from disk in case they have been modified there
 since being last loaded (may slightly speed up loading them).}
 
 XRC files from being reloaded from disk in case they have been modified there
 since being last loaded (may slightly speed up loading them).}
 

+\docparam{domain}{The name of the gettext catalog to search for
+  translatable strings.  By default all loaded catalogs will be
+  searched.  This provides a way to allow the strings to only come
+  from a specific catalog.}
+

 
 \membersection{wxXmlResource::\destruct{wxXmlResource}}\label{wxxmlresourcedtor}
 
 
 \membersection{wxXmlResource::\destruct{wxXmlResource}}\label{wxxmlresourcedtor}
 


@@ -72,12 +89,14 @@ Initializes only a specific handler (or custom handler). Convention says
 that the handler name is equal to the control's name plus 'XmlHandler', for example
 wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. The XML resource compiler
 (wxxrc) can create include file that contains initialization code for
 that the handler name is equal to the control's name plus 'XmlHandler', for example
 wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. The XML resource compiler
 (wxxrc) can create include file that contains initialization code for

-all controls used within the resource.
+all controls used within the resource. Note that this handler should be
+allocated on the heap, since it will be delete by 
+\helpref{ClearHandlers}{wxxmlresourceclearhandlers} later.

 
 
 \membersection{wxXmlResource::AttachUnknownControl}\label{wxxmlresourceattachunknowncontrol}
 
 
 
 \membersection{wxXmlResource::AttachUnknownControl}\label{wxxmlresourceattachunknowncontrol}
 

-\func{bool}{AttachUnknownControl}{\param{const wxString\& }{name}, \param{wxWindow* }{control}, \param{wxWindow* }{parent = NULL}}
+\func{bool}{AttachUnknownControl}{\param{const wxString\& }{name}, \param{wxWindow* }{control}, \param{wxWindow* }{parent = \NULL}}

 
 Attaches an unknown control to the given panel/window/dialog.
 Unknown controls are used in conjunction with <object class="unknown">.
 
 Attaches an unknown control to the given panel/window/dialog.
 Unknown controls are used in conjunction with <object class="unknown">.


@@ -87,7 +106,8 @@ Unknown controls are used in conjunction with <object class="unknown">.
 
 \func{void}{ClearHandlers}{\void}
 
 
 \func{void}{ClearHandlers}{\void}
 

-Removes all handlers.
+Removes all handlers and deletes them (this means that any handlers added using 
+\helpref{AddHandler}{wxxmlresourceaddhandler} must be allocated on the heap).

 
 
 \membersection{wxXmlResource::CompareVersion}\label{wxxmlresourcecompareversion}
 
 
 \membersection{wxXmlResource::CompareVersion}\label{wxxmlresourcecompareversion}


@@ -121,12 +141,14 @@ Returns version information (a.b.c.d = d+ 256*c + 256\textasciicircum2*b + 256\t
 
 \membersection{wxXmlResource::GetXRCID}\label{wxxmlresourcegetxmlid}
 
 
 \membersection{wxXmlResource::GetXRCID}\label{wxxmlresourcegetxmlid}
 

-\func{int}{GetXRCID}{\param{const wxChar* }{str\_id}}
+\func{int}{GetXRCID}{\param{const wxString\& }{str\_id}, \param{int }{value\_if\_not\_found = -2}}

 
 Returns a numeric ID that is equivalent to the string ID used in an XML
 
 Returns a numeric ID that is equivalent to the string ID used in an XML

-resource. To be used in event tables.
-The macro {\tt XRCID(name)} is provided for convenience.
-
+resource. If an unknown \arg{str\_id} is requested (i.e. other than wxID\_XXX
+or integer), a new record is created which associates the given string with
+a number. If \arg{value\_if\_not\_found} is \texttt{wxID\_NONE}, the number is obtained via
+\helpref{wxNewId()}{wxnewid}. Otherwise \arg{value\_if\_not\_found} is used.
+Macro {\tt XRCID(name)} is provided for convenient use in event tables.

 
 \membersection{wxXmlResource::InitAllHandlers}\label{wxxmlresourceinitallhandlers}
 
 
 \membersection{wxXmlResource::InitAllHandlers}\label{wxxmlresourceinitallhandlers}
 


@@ -170,7 +192,7 @@ Example:
 \begin{verbatim}
   MyDialog dlg;
   wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog");
 \begin{verbatim}
   MyDialog dlg;
   wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog");

-  dlg->ShowModal();
+  dlg.ShowModal();

 \end{verbatim}
 
 
 \end{verbatim}
 
 


@@ -192,18 +214,30 @@ Loads an icon resource from a file.
 
 \func{wxMenu*}{LoadMenu}{\param{const wxString\& }{name}}
 
 
 \func{wxMenu*}{LoadMenu}{\param{const wxString\& }{name}}
 

-Loads menu from resource. Returns NULL on failure.
+Loads menu from resource. Returns \NULL on failure.

 
 
 \membersection{wxXmlResource::LoadMenuBar}\label{wxxmlresourceloadmenubar}
 
 \func{wxMenuBar*}{LoadMenuBar}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 
 
 
 \membersection{wxXmlResource::LoadMenuBar}\label{wxxmlresourceloadmenubar}
 
 \func{wxMenuBar*}{LoadMenuBar}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 

-Loads a menubar from resource. Returns NULL on failure.
-

 \func{wxMenuBar*}{LoadMenuBar}{\param{const wxString\& }{name}}
 
 \func{wxMenuBar*}{LoadMenuBar}{\param{const wxString\& }{name}}
 

-Loads a menubar from resource. Returns NULL on failure.
+Loads a menubar from resource. Returns \NULL on failure.
+
+
+\membersection{wxXmlResource::LoadObject}\label{wxxmlresourceloadobject}
+
+\func{wxObject*}{LoadObject}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}, \param{const wxString\& }{classname}}
+
+\func{bool}{LoadObject}{\param{wxObject* }{instance}, \param{wxWindow* }{parent}, \param{const wxString\& }{name}, \param{const wxString\& }{classname}}
+
+Load an object from the resource specifying both the resource name and the
+class name.
+
+The first overload lets you load nonstandard container windows and returns \NULL
+on failure. The second one lets you finish the creation of an existing
+instance and returns \false on failure.

 
 
 \membersection{wxXmlResource::LoadPanel}\label{wxxmlresourceloadpanel}
 
 
 \membersection{wxXmlResource::LoadPanel}\label{wxxmlresourceloadpanel}


@@ -229,7 +263,7 @@ Loads a toolbar.
 
 \func{wxXmlResource*}{Set}{\param{wxXmlResource* }{res}}
 
 
 \func{wxXmlResource*}{Set}{\param{wxXmlResource* }{res}}
 

-Sets the global resources object and returns a pointer to the previous one (may be NULL).
+Sets the global resources object and returns a pointer to the previous one (may be \NULL).

 
 
 \membersection{wxXmlResource::SetFlags}\label{wxxmlresourcesetflags}
 
 
 \membersection{wxXmlResource::SetFlags}\label{wxxmlresourcesetflags}


@@ -249,3 +283,20 @@ This function unloads a resource previously loaded by
 Returns \true if the resource was successfully unloaded and \false if it hasn't
 been found in the list of loaded resources.
 
 Returns \true if the resource was successfully unloaded and \false if it hasn't
 been found in the list of loaded resources.
 

+
+
+\membersection{wxXmlResource::GetDomain}\label{wxxmlresourcegetdomain}
+
+\func{wxChar*}{GetDomain}{}
+
+Returns the domain (message catalog) that will be used to load
+translatable strings in the XRC.
+
+
+\membersection{wxXmlResource::SetDomain}\label{wxxmlresourcesetdomain}
+
+\func{wxChar*}{SetDomain}{\param{const wxChar* }{domain}}
+
+Sets the domain (message catalog) that will be used to load
+translatable strings in the XRC.
+