X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bd330a69c9555c29c6fc448a61e58e0d49402c47..3faa8195d724c3951a6becd501c989ac3c3906ef:/docs/latex/wx/xmlres.tex diff --git a/docs/latex/wx/xmlres.tex b/docs/latex/wx/xmlres.tex index ed5913cd23..741c5e4120 100644 --- a/docs/latex/wx/xmlres.tex +++ b/docs/latex/wx/xmlres.tex @@ -11,10 +11,6 @@ The class holds XML resources from one or more .xml files, binary files or zip a See \helpref{XML-based resource system overview}{xrcoverview} for details. -{\bf NOTE:} XRC is not yet a part of the core wxWindows library, so -please see the overview for how to compile and link it. Otherwise if you -try to use it, you will get link errors. - \wxheading{Derived from} \helpref{wxObject}{wxobject} @@ -25,17 +21,17 @@ try to use it, you will get link errors. \wxheading{Data structures} -\begin{enumerate} +\begin{verbatim} enum wxXmlResourceFlags { wxXRC_USE_LOCALE = 1, wxXRC_NO_SUBCLASSING = 2 }; -\end{enumerate} +\end{verbatim} \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}} @@ -92,24 +88,6 @@ Removes all handlers. 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::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. - \membersection{wxXmlResource::Get}\label{wxxmlresourceget} \func{wxXmlResource*}{Get}{\void} @@ -126,15 +104,15 @@ Returns flags, which may be a bitlist of wxXRC\_USE\_LOCALE and wxXRC\_NO\_SUBCL \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 resource. To be used in event tables. -The macro \verb$XMLID(name)$ is provided for convenience. +The macro {\tt XRCID(name)} is provided for convenience. \membersection{wxXmlResource::InitAllHandlers}\label{wxxmlresourceinitallhandlers} @@ -142,7 +120,7 @@ The macro \verb$XMLID(name)$ is provided for convenience. Initializes handlers for all supported controls/windows. This will 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} @@ -229,10 +207,9 @@ Loads a toolbar. 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}{UpdateResources}{\void} +\func{void}{SetFlags}{\param{int }{flags}} -Scans the resources list for unloaded files and loads them. Also reloads -files that have been modified since the last load. +Sets flags (bitlist of wxXRC\_USE\_LOCALE and wxXRC\_NO\_SUBCLASSING).