<wx/xrc/xmlres.h>
+\wxheading{Library}
+
+\helpref{wxXrc}{librarieslist}
+
\wxheading{Constants}
\begin{verbatim}
\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.
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.
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}
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}
-\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">.
\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::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
-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}
\begin{verbatim}
MyDialog dlg;
wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog");
- dlg->ShowModal();
+ dlg.ShowModal();
\end{verbatim}
\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}}
-Loads a menubar from resource. Returns NULL on failure.
-
\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}
\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}
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.
+
projects / wxWidgets.git / blobdiff