define _HPUX_SOURCE under HP-UX, otherwise many things are not defined in standard...

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

diff --git a/docs/latex/wx/xmlres.tex b/docs/latex/wx/xmlres.tex
index 214f28ef2494d0bf9f0f0855926b4be435e815eb..7ef4cf75df44eff07eb5d9069594930854261cd3 100644 (file)
--- a/docs/latex/wx/xmlres.tex
+++ b/docs/latex/wx/xmlres.tex
@@ -3,13 +3,13 @@
 % xmlres.h at 22/Jan/02 23:08:28
 %
 
 % xmlres.h at 22/Jan/02 23:08:28
 %
 

-

 \section{\class{wxXmlResource}}\label{wxxmlresource}
 
 \section{\class{wxXmlResource}}\label{wxxmlresource}
 

+This is the main class for interacting with the XML-based resource system.
+
+The class holds XML resources from one or more .xml files, binary files or zip archive files.

 
 

-This class holds XML resources from one or more .xml files
-(or derived forms, either binary or zipped -- see manual for
-details).
+See \helpref{XML-based resource system overview}{xrcoverview} for details.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -17,33 +17,44 @@ details).
 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 

-<xmlres.h>
+<wx/xrc/xmlres.h>

 
 

-\wxheading{Data structures}
+\wxheading{Constants}
+
+\begin{verbatim}
+enum wxXmlResourceFlags
+{
+    wxXRC_USE_LOCALE     = 1,
+    wxXRC_NO_SUBCLASSING = 2,
+    wxXRC_NO_RELOADING   = 4
+};
+\end{verbatim}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 

-\membersection{wxXmlResource::wxXmlResource}\label{wxxmlresourcewxxmlresource}
+\membersection{wxXmlResource::wxXmlResource}\label{wxxmlresourcector}

 
 \func{}{wxXmlResource}{\param{const wxString\& }{filemask}, \param{int }{flags = wxXRC\_USE\_LOCALE}}
 
 Constructor.
 
 \func{}{wxXmlResource}{\param{const wxString\& }{filemask}, \param{int }{flags = wxXRC\_USE\_LOCALE}}
 
 Constructor.

-Flags: wxXRC\_USE\_LOCALE
-translatable strings will be translated via \_()
-wxXRC\_NO\_SUBCLASSING
-subclass property of object nodes will be ignored
-(useful for previews in XRC editors)

 
 

+\docparam{filemask}{The XRC file, archive file, or wildcard specification that will be used to
+load all resource files inside a zip archive.}
+
+\docparam{flags}{wxXRC\_USE\_LOCALE: translatable strings will be translated via \_().
+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}}
 
 Constructor.
 
 \func{}{wxXmlResource}{\param{int }{flags = wxXRC\_USE\_LOCALE}}
 
 Constructor.

-Flags: wxXRC\_USE\_LOCALE
-translatable strings will be translated via \_()
-wxXRC\_NO\_SUBCLASSING
-subclass property of object nodes will be ignored
-(useful for previews in XRC editors)
+
+\docparam{flags}{wxXRC\_USE\_LOCALE: translatable strings will be translated via \_().
+wxXRC\_NO\_SUBCLASSING: subclass property of object nodes will be ignored
+(useful for previews in XRC editors). wxXRC\_NO\_RELOADING will prevent the
+XRC files from being reloaded from disk in case they have been modified there
+since being last loaded (may slightly speed up loading them).}

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


@@ -57,10 +68,10 @@ Destructor.
 
 \func{void}{AddHandler}{\param{wxXmlResourceHandler* }{handler}}
 
 
 \func{void}{AddHandler}{\param{wxXmlResourceHandler* }{handler}}
 

-Initialize only a specific handler (or custom handler). Convention says
-that handler name is equal to the control's name plus 'XmlHandler', for example
+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
 wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. The XML resource compiler

-(xmlres) can create include file that contains initialization code for
+(wxxrc) can create include file that contains initialization code for

 all controls used within the resource.
 
 
 all controls used within the resource.
 
 


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

-Removes all handlers
+Removes all handlers.

 
 
 \membersection{wxXmlResource::CompareVersion}\label{wxxmlresourcecompareversion}
 
 \constfunc{int}{CompareVersion}{\param{int }{major}, \param{int }{minor}, \param{int }{release}, \param{int }{revision}}
 
 
 
 \membersection{wxXmlResource::CompareVersion}\label{wxxmlresourcecompareversion}
 
 \constfunc{int}{CompareVersion}{\param{int }{major}, \param{int }{minor}, \param{int }{release}, \param{int }{revision}}
 

-Compares resources version to argument. Returns -1 if resources version
-is less than the argument, +1 if greater and 0 if they equal.
-
-
-\membersection{wxXmlResource::CreateResFromNode}\label{wxxmlresourcecreateresfromnode}
-
-\func{wxObject*}{CreateResFromNode}{\param{wxXmlNode* }{node}, \param{wxObject* }{parent}, \param{wxObject* }{instance = NULL}}
-
-Creates a resource from information in the given node.
-
-
-\membersection{wxXmlResource::DoFindResource}\label{wxxmlresourcedofindresource}
-
-\func{wxXmlNode*}{DoFindResource}{\param{wxXmlNode* }{parent}, \param{const wxString\& }{name}, \param{const wxString\& }{classname}, \param{bool }{recursive}}
-
-Helper function: finds a resource (calls UpdateResources) and returns a node containing it.
-
-
-\membersection{wxXmlResource::FindResource}\label{wxxmlresourcefindresource}
-
-\func{wxXmlNode*}{FindResource}{\param{const wxString\& }{name}, \param{const wxString\& }{classname}, \param{bool }{recursive = FALSE}}
-
-Finds a resource (calls UpdateResources) and returns a node containing it.
+Compares the XRC version to the argument. Returns -1 if the XRC version
+is less than the argument, +1 if greater, and 0 if they equal.

 
 
 \membersection{wxXmlResource::Get}\label{wxxmlresourceget}
 
 \func{wxXmlResource*}{Get}{\void}
 
 
 
 \membersection{wxXmlResource::Get}\label{wxxmlresourceget}
 
 \func{wxXmlResource*}{Get}{\void}
 

-Singleton accessors.

 Gets the global resources object or creates one if none exists.
 
 
 Gets the global resources object or creates one if none exists.
 
 


@@ -127,25 +116,25 @@ Returns flags, which may be a bitlist of wxXRC\_USE\_LOCALE and wxXRC\_NO\_SUBCL
 
 \constfunc{long}{GetVersion}{\void}
 
 
 \constfunc{long}{GetVersion}{\void}
 

-Returns version information (a.b.c.d = d+ 256*c + 256\verb|^|2*b + 256\verb|^|3*a).
+Returns version information (a.b.c.d = d+ 256*c + 256\textasciicircum2*b + 256\textasciitilde3*a).

 
 
 
 

-\membersection{wxXmlResource::GetXMLID}\label{wxxmlresourcegetxmlid}
+\membersection{wxXmlResource::GetXRCID}\label{wxxmlresourcegetxmlid}

 
 

-\func{int}{GetXMLID}{\param{const wxChar* }{str\_id}}
+\func{int}{GetXRCID}{\param{const wxChar* }{str\_id}}

 
 

-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.
 resource. To be used in event tables.

-Macro XMLID is provided for convenience
+The macro {\tt XRCID(name)} is provided for convenience.

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

-Initialize handlers for all supported controls/windows. This will
+Initializes handlers for all supported controls/windows. This will

 make the executable quite big because it forces linking against
 make the executable quite big because it forces linking against

-most of the wxWindows library.
+most of the wxWidgets library.

 
 
 \membersection{wxXmlResource::Load}\label{wxxmlresourceload}
 
 
 \membersection{wxXmlResource::Load}\label{wxxmlresourceload}


@@ -167,18 +156,22 @@ Loads a bitmap resource from a file.
 
 \func{wxDialog*}{LoadDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 
 
 \func{wxDialog*}{LoadDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 

-Loads a dialog. dlg points to parent window (if any).
-
+Loads a dialog. {\it dlg} points to a parent window (if any).

 
 \func{bool}{LoadDialog}{\param{wxDialog* }{dlg}, \param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 
 
 \func{bool}{LoadDialog}{\param{wxDialog* }{dlg}, \param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 

-Loads a dialog. dlg points to parent window (if any). This form
-is used to finish creation of already existing instance (main reason
-for this is that you may want to use derived class with new event table)
-Example (typical usage):
-MyDialog dlg;
-wxTheXmlResource->LoadDialog(\&dlg, mainFrame, "my\_dialog");
-dlg->ShowModal();
+Loads a dialog. {\it dlg} points to parent window (if any).
+
+This form is used to finish creation of an already existing instance (the main reason
+for this is that you may want to use derived class with a new event table).
+
+Example:
+
+\begin{verbatim}
+  MyDialog dlg;
+  wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog");
+  dlg->ShowModal();
+\end{verbatim}

 
 
 \membersection{wxXmlResource::LoadFrame}\label{wxxmlresourceloadframe}
 
 
 \membersection{wxXmlResource::LoadFrame}\label{wxxmlresourceloadframe}


@@ -206,25 +199,23 @@ Loads menu from resource. Returns NULL on failure.
 
 \func{wxMenuBar*}{LoadMenuBar}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 
 
 \func{wxMenuBar*}{LoadMenuBar}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 

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

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

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

 
 
 \membersection{wxXmlResource::LoadPanel}\label{wxxmlresourceloadpanel}
 
 \func{wxPanel*}{LoadPanel}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 
 
 
 \membersection{wxXmlResource::LoadPanel}\label{wxxmlresourceloadpanel}
 
 \func{wxPanel*}{LoadPanel}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 

-Loads a panel. panel points to parent window (if any).
-
+Loads a panel. {\it panel} points to parent window (if any).

 
 \func{bool}{LoadPanel}{\param{wxPanel* }{panel}, \param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 
 
 \func{bool}{LoadPanel}{\param{wxPanel* }{panel}, \param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 

-Loads a panel. panel points to parent window (if any). This form
-is used to finish creation of already existing instance.
+Loads a panel. {\it panel} points to parent window (if any). This form
+is used to finish creation of an already existing instance.

 
 
 \membersection{wxXmlResource::LoadToolBar}\label{wxxmlresourceloadtoolbar}
 
 
 \membersection{wxXmlResource::LoadToolBar}\label{wxxmlresourceloadtoolbar}


@@ -241,10 +232,20 @@ Loads a toolbar.
 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::UpdateResources}\label{wxxmlresourceupdateresources}
+\membersection{wxXmlResource::SetFlags}\label{wxxmlresourcesetflags}
+
+\func{void}{SetFlags}{\param{int }{flags}}
+
+Sets flags (bitlist of wxXRC\_USE\_LOCALE and wxXRC\_NO\_SUBCLASSING).
+
+
+\membersection{wxXmlResource::Unload}\label{wxxmlresourceunload}
+
+\func{bool}{Unload}{\param{const wxString\& }{filename}}

 
 

-\func{void}{UpdateResources}{\void}
+This function unloads a resource previously loaded by 
+\helpref{Load()}{wxxmlresourceload}.

 
 

-Scans the resources list for unloaded files and loads them. Also reloads
-files that have been modified since last loading.
+Returns \true if the resource was successfully unloaded and \false if it hasn't
+been found in the list of loaded resources.