use wxChar correctly in wxString docs; mark wx1 compatibility functions

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

diff --git a/docs/latex/wx/xmlres.tex b/docs/latex/wx/xmlres.tex
index 7ef4cf75df44eff07eb5d9069594930854261cd3..0f924330d2975b120c1fe5dfe6466d026516639d 100644 (file)
--- a/docs/latex/wx/xmlres.tex
+++ b/docs/latex/wx/xmlres.tex
@@ -35,7 +35,9 @@ enum wxXmlResourceFlags
 
 \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.
 
@@ -46,7 +48,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).}
 
-\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.
 
@@ -56,6 +64,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).}
 
+\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}
 
@@ -72,7 +85,9 @@ 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
-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}
@@ -87,7 +102,8 @@ Unknown controls are used in conjunction with <object class="unknown">.
 
 \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}
@@ -121,12 +137,14 @@ Returns version information (a.b.c.d = d+ 256*c + 256\textasciicircum2*b + 256\t
 
 \membersection{wxXmlResource::GetXRCID}\label{wxxmlresourcegetxmlid}
 
-\func{int}{GetXRCID}{\param{const wxChar* }{str\_id}}
+\func{int}{GetXRCID}{\param{const wxChar* }{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. 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}
 
@@ -249,3 +267,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.
 
+
+
+\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.
+