]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/xmlresh.tex
added tied scoped pointers
[wxWidgets.git] / docs / latex / wx / xmlresh.tex
index ffe10e9f9a0e59efb3c7c356486996e1ecbc819f..fe03e0dc99b2d6d78a0a2d110d1904ce4d60dcb4 100644 (file)
@@ -53,12 +53,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 +87,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,9 +106,9 @@ 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}
 
@@ -196,7 +203,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}