X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2edb0bdef6238c8c246b6978bc14828b7033d931..a607d8d633e055fc5cea22c0b829cd65b5c3dbfb:/docs/latex/wx/xmlresh.tex diff --git a/docs/latex/wx/xmlresh.tex b/docs/latex/wx/xmlresh.tex index b469b224bc..3ae6789bf7 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} @@ -22,9 +18,13 @@ try to use it, you will get link errors. +\wxheading{Library} + +\helpref{wxXrc}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxXmlResourceHandler::wxXmlResourceHandler}\label{wxxmlresourcehandlerwxxmlresourcehandler} +\membersection{wxXmlResourceHandler::wxXmlResourceHandler}\label{wxxmlresourcehandlerctor} \func{}{wxXmlResourceHandler}{\void} @@ -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. @@ -91,6 +98,12 @@ should rather use this one, and call its Create method. Called from CreateResource after variables were filled. +\membersection{wxXmlResourceHandler::GetAnimation}\label{wxxmlresourcehandlergetanimation} + +\func{wxAnimation}{GetAnimation}{\param{const wxString\& }{param = wxT("animation")}} + +Creates a \helpref{animation}{wxanimation} from the filename specified in \arg{param}. + \membersection{wxXmlResourceHandler::GetBitmap}\label{wxxmlresourcehandlergetbitmap} \func{wxBitmap}{GetBitmap}{\param{const wxString\& }{param = wxT("bitmap")}, \param{wxSize }{size = wxDefaultSize}} @@ -99,13 +112,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).