Moved desktop margin options to a more sensible place

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

diff --git a/docs/latex/wx/xmlres.tex b/docs/latex/wx/xmlres.tex
index c14a210f073b5856c072db80bb707a401662517e..352864ade0dbcf7b36076825f11d16330d719580 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}
 


@@ -73,7 +90,8 @@ that the handler name is equal to the control's name plus 'XmlHandler', for exam
 wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. The XML resource compiler
 (wxxrc) can create include file that contains initialization code for
 all controls used within the resource. Note that this handler should be
 wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. The XML resource compiler
 (wxxrc) can create include file that contains initialization code for
 all controls used within the resource. Note that this handler should be

-located on heap instead of stack, since it will get destroyed on shutdown.
+allocated on the heap, since it will be delete by 
+\helpref{ClearHandlers}{wxxmlresourceclearhandlers} later.

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


@@ -88,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}


@@ -122,7 +141,7 @@ 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}, \param{int }{value\_if\_not\_found = -2}}
+\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
 resource. If an unknown \arg{str\_id} is requested (i.e. other than wxID\_XXX
 
 Returns a numeric ID that is equivalent to the string ID used in an XML
 resource. If an unknown \arg{str\_id} is requested (i.e. other than wxID\_XXX


@@ -173,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}
 
 


@@ -252,3 +271,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.
+