X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bd330a69c9555c29c6fc448a61e58e0d49402c47..7a9763046b9f7b99399d5538d204b3d8c03bbc2e:/docs/latex/wx/xmlresh.tex?ds=sidebyside diff --git a/docs/latex/wx/xmlresh.tex b/docs/latex/wx/xmlresh.tex index 26dcddd9c9..08671ff6a5 100644 --- a/docs/latex/wx/xmlresh.tex +++ b/docs/latex/wx/xmlresh.tex @@ -10,10 +10,6 @@ capable of creating a control from an XML node. 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} @@ -24,7 +20,7 @@ try to use it, you will get link errors. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxXmlResourceHandler::wxXmlResourceHandler}\label{wxxmlresourcehandlerwxxmlresourcehandler} +\membersection{wxXmlResourceHandler::wxXmlResourceHandler}\label{wxxmlresourcehandlerctor} \func{}{wxXmlResourceHandler}{\void} @@ -53,12 +49,19 @@ Add styles common to all wxWindow-derived classes. \func{bool}{CanHandle}{\param{wxXmlNode* }{node}} -Returns TRUE if it understands this node and can create -a resource from it, FALSE otherwise. +Returns true if it understands this node and can create +a resource from it, false otherwise. + +\wxheading{Note} + +You must {\bf not} call any wxXmlResourceHandler methods except +\helpref{IsOfClass}{wxxmlresourcehandlerisofclass} from this method! The instance +is not yet initialized with node data at the time CanHandle is called and it is only +safe to operate on {\it node} directly or to call IsOfClass. \membersection{wxXmlResourceHandler::CreateChildren}\label{wxxmlresourcehandlercreatechildren} -\func{void}{CreateChildren}{\param{wxObject* }{parent}, \param{bool }{this\_hnd\_only = FALSE}} +\func{void}{CreateChildren}{\param{wxObject* }{parent}, \param{bool }{this\_hnd\_only = false}} Creates children. @@ -80,7 +83,7 @@ Creates a resource from a node. Creates an object (menu, dialog, control, ...) from an XML node. Should check for validity. {\it parent} is a higher-level object (usually window, dialog or panel) -that is often neccessary to create the resource. +that is often necessary to create the resource. If {\bf instance} is non-NULL it should not create a new instance via 'new' but should rather use this one, and call its Create method. @@ -99,13 +102,13 @@ Gets a bitmap. \membersection{wxXmlResourceHandler::GetBool}\label{wxxmlresourcehandlergetbool} -\func{bool}{GetBool}{\param{const wxString\& }{param}, \param{bool }{defaultv = FALSE}} +\func{bool}{GetBool}{\param{const wxString\& }{param}, \param{bool }{defaultv = false}} -Gets a bool flag (1, t, yes, on, true are TRUE, everything else is FALSE). +Gets a bool flag (1, t, yes, on, true are true, everything else is false). \membersection{wxXmlResourceHandler::GetColour}\label{wxxmlresourcehandlergetcolour} -\func{wxColour}{GetColour}{\param{const wxString\& }{param}} +\func{wxColour}{GetColour}{\param{const wxString\& }{param}, \param{const wxColour\& }{default = wxNullColour}} Gets colour in HTML syntax (\#RRGGBB). @@ -131,7 +134,7 @@ Gets a font. \func{int}{GetID}{\void} -Returns the XMLID. +Returns the XRCID. \membersection{wxXmlResourceHandler::GetIcon}\label{wxxmlresourcehandlergeticon} @@ -196,7 +199,7 @@ Gets text from param and does some conversions: \begin{itemize}\itemsep=0pt \item replaces $\backslash$n, $\backslash$r, $\backslash$t by respective characters (according to C syntax) -\item replaces \verb+$+ by \verb+\&+ and \verb+\$\$+ by \verb+\$+ (needed for \verb+\$File+ to \verb+\&File+ +\item replaces {\tt\$} by {\tt\&} and {\tt\$\$} by {\tt\$} (needed for {\tt\_File} to {\tt\&File} translation because of XML syntax) \item calls wxGetTranslations (unless disabled in wxXmlResource) \end{itemize}