2 % automatically generated by HelpGen $Revision$ from
3 % xmlres.h at 22/Jan/02 23:08:28
6 \section{\class{wxXmlResourceHandler
}}\label{wxxmlresourcehandler
}
8 wxXmlResourceHandler is an abstract base class for resource handlers
9 capable of creating a control from an XML node.
11 See
\helpref{XML-based resource system overview
}{xrcoverview
} for details.
13 \wxheading{Derived from
}
15 \helpref{wxObject
}{wxobject
}
17 \wxheading{Include files
}
21 \latexignore{\rtfignore{\wxheading{Members
}}}
23 \membersection{wxXmlResourceHandler::wxXmlResourceHandler
}\label{wxxmlresourcehandlerwxxmlresourcehandler
}
25 \func{}{wxXmlResourceHandler
}{\void}
29 \membersection{wxXmlResourceHandler::
\destruct{wxXmlResourceHandler
}}\label{wxxmlresourcehandlerdtor
}
31 \func{}{\destruct{wxXmlResourceHandler
}}{\void}
35 \membersection{wxXmlResourceHandler::AddStyle
}\label{wxxmlresourcehandleraddstyle
}
37 \func{void
}{AddStyle
}{\param{const wxString\&
}{name
},
\param{int
}{value
}}
39 Add a style flag (e.g. wxMB
\_DOCKABLE) to the list of flags
40 understood by this handler.
42 \membersection{wxXmlResourceHandler::AddWindowStyles
}\label{wxxmlresourcehandleraddwindowstyles
}
44 \func{void
}{AddWindowStyles
}{\void}
46 Add styles common to all wxWindow-derived classes.
48 \membersection{wxXmlResourceHandler::CanHandle
}\label{wxxmlresourcehandlercanhandle
}
50 \func{bool
}{CanHandle
}{\param{wxXmlNode*
}{node
}}
52 Returns true if it understands this node and can create
53 a resource from it, false otherwise.
57 You must
{\bf not
} call any wxXmlResourceHandler methods except
58 \helpref{IsOfClass
}{wxxmlresourcehandlerisofclass
} from this method! The instance
59 is not yet initialized with node data at the time CanHandle is called and it is only
60 safe to operate on
{\it node
} directly or to call IsOfClass.
62 \membersection{wxXmlResourceHandler::CreateChildren
}\label{wxxmlresourcehandlercreatechildren
}
64 \func{void
}{CreateChildren
}{\param{wxObject*
}{parent
},
\param{bool
}{this
\_hnd\_only = false
}}
68 \membersection{wxXmlResourceHandler::CreateChildrenPrivately
}\label{wxxmlresourcehandlercreatechildrenprivately
}
70 \func{void
}{CreateChildrenPrivately
}{\param{wxObject*
}{parent
},
\param{wxXmlNode*
}{rootnode = NULL
}}
74 \membersection{wxXmlResourceHandler::CreateResFromNode
}\label{wxxmlresourcehandlercreateresfromnode
}
76 \func{wxObject*
}{CreateResFromNode
}{\param{wxXmlNode*
}{node
},
\param{wxObject*
}{parent
},
\param{wxObject*
}{instance = NULL
}}
78 Creates a resource from a node.
80 \membersection{wxXmlResourceHandler::CreateResource
}\label{wxxmlresourcehandlercreateresource
}
82 \func{wxObject*
}{CreateResource
}{\param{wxXmlNode*
}{node
},
\param{wxObject*
}{parent
},
\param{wxObject*
}{instance
}}
84 Creates an object (menu, dialog, control, ...) from an XML node.
85 Should check for validity.
{\it parent
} is a higher-level object (usually window, dialog or panel)
86 that is often necessary to create the resource.
87 If
{\bf instance
} is non-NULL it should not create a new instance via 'new' but
88 should rather use this one, and call its Create method.
90 \membersection{wxXmlResourceHandler::DoCreateResource
}\label{wxxmlresourcehandlerdocreateresource
}
92 \func{wxObject*
}{DoCreateResource
}{\void}
94 Called from CreateResource after variables
97 \membersection{wxXmlResourceHandler::GetBitmap
}\label{wxxmlresourcehandlergetbitmap
}
99 \func{wxBitmap
}{GetBitmap
}{\param{const wxString\&
}{param = wxT("bitmap")
},
\param{wxSize
}{size = wxDefaultSize
}}
103 \membersection{wxXmlResourceHandler::GetBool
}\label{wxxmlresourcehandlergetbool
}
105 \func{bool
}{GetBool
}{\param{const wxString\&
}{param
},
\param{bool
}{defaultv = false
}}
107 Gets a bool flag (
1, t, yes, on, true are true, everything else is false).
109 \membersection{wxXmlResourceHandler::GetColour
}\label{wxxmlresourcehandlergetcolour
}
111 \func{wxColour
}{GetColour
}{\param{const wxString\&
}{param
}}
113 Gets colour in HTML syntax (\#RRGGBB).
115 \membersection{wxXmlResourceHandler::GetCurFileSystem
}\label{wxxmlresourcehandlergetcurfilesystem
}
117 \func{wxFileSystem\&
}{GetCurFileSystem
}{\void}
119 Returns the current file system.
121 \membersection{wxXmlResourceHandler::GetDimension
}\label{wxxmlresourcehandlergetdimension
}
123 \func{wxCoord
}{GetDimension
}{\param{const wxString\&
}{param
},
\param{wxCoord
}{defaultv =
0}}
125 Gets a dimension (may be in dialog units).
127 \membersection{wxXmlResourceHandler::GetFont
}\label{wxxmlresourcehandlergetfont
}
129 \func{wxFont
}{GetFont
}{\param{const wxString\&
}{param = wxT("font")
}}
133 \membersection{wxXmlResourceHandler::GetID
}\label{wxxmlresourcehandlergetid
}
135 \func{int
}{GetID
}{\void}
139 \membersection{wxXmlResourceHandler::GetIcon
}\label{wxxmlresourcehandlergeticon
}
141 \func{wxIcon
}{GetIcon
}{\param{const wxString\&
}{param = wxT("icon")
},
\param{wxSize
}{size = wxDefaultSize
}}
145 \membersection{wxXmlResourceHandler::GetLong
}\label{wxxmlresourcehandlergetlong
}
147 \func{long
}{GetLong
}{\param{const wxString\&
}{param
},
\param{long
}{defaultv =
0}}
149 Gets the integer value from the parameter.
151 \membersection{wxXmlResourceHandler::GetName
}\label{wxxmlresourcehandlergetname
}
153 \func{wxString
}{GetName
}{\void}
155 Returns the resource name.
157 \membersection{wxXmlResourceHandler::GetNodeContent
}\label{wxxmlresourcehandlergetnodecontent
}
159 \func{wxString
}{GetNodeContent
}{\param{wxXmlNode*
}{node
}}
161 Gets node content from wxXML
\_ENTITY\_NODE.
163 \membersection{wxXmlResourceHandler::GetParamNode
}\label{wxxmlresourcehandlergetparamnode
}
165 \func{wxXmlNode*
}{GetParamNode
}{\param{const wxString\&
}{param
}}
167 Finds the node or returns NULL.
169 \membersection{wxXmlResourceHandler::GetParamValue
}\label{wxxmlresourcehandlergetparamvalue
}
171 \func{wxString
}{GetParamValue
}{\param{const wxString\&
}{param
}}
173 Finds the parameter value or returns the empty string.
175 \membersection{wxXmlResourceHandler::GetPosition
}\label{wxxmlresourcehandlergetposition
}
177 \func{wxPoint
}{GetPosition
}{\param{const wxString\&
}{param = wxT("pos")
}}
179 Gets the position (may be in dialog units).
181 \membersection{wxXmlResourceHandler::GetSize
}\label{wxxmlresourcehandlergetsize
}
183 \func{wxSize
}{GetSize
}{\param{const wxString\&
}{param = wxT("size")
}}
185 Gets the size (may be in dialog units).
187 \membersection{wxXmlResourceHandler::GetStyle
}\label{wxxmlresourcehandlergetstyle
}
189 \func{int
}{GetStyle
}{\param{const wxString\&
}{param = wxT("style")
},
\param{int
}{defaults =
0}}
191 Gets style flags from text in form "flag | flag2| flag3 |..."
192 Only understands flags added with AddStyle.
194 \membersection{wxXmlResourceHandler::GetText
}\label{wxxmlresourcehandlergettext
}
196 \func{wxString
}{GetText
}{\param{const wxString\&
}{param
}}
198 Gets text from param and does some conversions:
200 \begin{itemize
}\itemsep=
0pt
201 \item replaces $
\backslash$n, $
\backslash$r, $
\backslash$t by respective characters (according to C syntax)
202 \item replaces
{\tt\$
} by
{\tt\&
} and
{\tt\$\$
} by
{\tt\$
} (needed for
{\tt\_File} to
{\tt\&File
}
203 translation because of XML syntax)
204 \item calls wxGetTranslations (unless disabled in wxXmlResource)
207 \membersection{wxXmlResourceHandler::HasParam
}\label{wxxmlresourcehandlerhasparam
}
209 \func{bool
}{HasParam
}{\param{const wxString\&
}{param
}}
211 Check to see if a parameter exists.
213 \membersection{wxXmlResourceHandler::IsOfClass
}\label{wxxmlresourcehandlerisofclass
}
215 \func{bool
}{IsOfClass
}{\param{wxXmlNode*
}{node
},
\param{const wxString\&
}{classname
}}
217 Convenience function. Returns true if the node has a property class equal to classname,
218 e.g. <object class="wxDialog">.
220 \membersection{wxXmlResourceHandler::SetParentResource
}\label{wxxmlresourcehandlersetparentresource
}
222 \func{void
}{SetParentResource
}{\param{wxXmlResource*
}{res
}}
224 Sets the parent resource.
226 \membersection{wxXmlResourceHandler::SetupWindow
}\label{wxxmlresourcehandlersetupwindow
}
228 \func{void
}{SetupWindow
}{\param{wxWindow*
}{wnd
}}
230 Sets common window options.