]>
Commit | Line | Data |
---|---|---|
1 | % | |
2 | % automatically generated by HelpGen $Revision$ from | |
3 | % xmlres.h at 22/Jan/02 23:08:28 | |
4 | % | |
5 | ||
6 | \section{\class{wxXmlResourceHandler}}\label{wxxmlresourcehandler} | |
7 | ||
8 | wxXmlResourceHandler is an abstract base class for resource handlers | |
9 | capable of creating a control from an XML node. | |
10 | ||
11 | See \helpref{XML-based resource system overview}{xrcoverview} for details. | |
12 | ||
13 | {\bf NOTE:} XRC is not yet a part of the core wxWindows library, so | |
14 | please see the overview for how to compile and link it. Otherwise if you | |
15 | try to use it, you will get link errors. | |
16 | ||
17 | \wxheading{Derived from} | |
18 | ||
19 | \helpref{wxObject}{wxobject} | |
20 | ||
21 | \wxheading{Include files} | |
22 | ||
23 | <wx/xrc/xmlres.h> | |
24 | ||
25 | \latexignore{\rtfignore{\wxheading{Members}}} | |
26 | ||
27 | \membersection{wxXmlResourceHandler::wxXmlResourceHandler}\label{wxxmlresourcehandlerwxxmlresourcehandler} | |
28 | ||
29 | \func{}{wxXmlResourceHandler}{\void} | |
30 | ||
31 | Default constructor. | |
32 | ||
33 | \membersection{wxXmlResourceHandler::\destruct{wxXmlResourceHandler}}\label{wxxmlresourcehandlerdtor} | |
34 | ||
35 | \func{}{\destruct{wxXmlResourceHandler}}{\void} | |
36 | ||
37 | Destructor. | |
38 | ||
39 | \membersection{wxXmlResourceHandler::AddStyle}\label{wxxmlresourcehandleraddstyle} | |
40 | ||
41 | \func{void}{AddStyle}{\param{const wxString\& }{name}, \param{int }{value}} | |
42 | ||
43 | Add a style flag (e.g. wxMB\_DOCKABLE) to the list of flags | |
44 | understood by this handler. | |
45 | ||
46 | \membersection{wxXmlResourceHandler::AddWindowStyles}\label{wxxmlresourcehandleraddwindowstyles} | |
47 | ||
48 | \func{void}{AddWindowStyles}{\void} | |
49 | ||
50 | Add styles common to all wxWindow-derived classes. | |
51 | ||
52 | \membersection{wxXmlResourceHandler::CanHandle}\label{wxxmlresourcehandlercanhandle} | |
53 | ||
54 | \func{bool}{CanHandle}{\param{wxXmlNode* }{node}} | |
55 | ||
56 | Returns TRUE if it understands this node and can create | |
57 | a resource from it, FALSE otherwise. | |
58 | ||
59 | \membersection{wxXmlResourceHandler::CreateChildren}\label{wxxmlresourcehandlercreatechildren} | |
60 | ||
61 | \func{void}{CreateChildren}{\param{wxObject* }{parent}, \param{bool }{this\_hnd\_only = FALSE}} | |
62 | ||
63 | Creates children. | |
64 | ||
65 | \membersection{wxXmlResourceHandler::CreateChildrenPrivately}\label{wxxmlresourcehandlercreatechildrenprivately} | |
66 | ||
67 | \func{void}{CreateChildrenPrivately}{\param{wxObject* }{parent}, \param{wxXmlNode* }{rootnode = NULL}} | |
68 | ||
69 | Helper function. | |
70 | ||
71 | \membersection{wxXmlResourceHandler::CreateResFromNode}\label{wxxmlresourcehandlercreateresfromnode} | |
72 | ||
73 | \func{wxObject*}{CreateResFromNode}{\param{wxXmlNode* }{node}, \param{wxObject* }{parent}, \param{wxObject* }{instance = NULL}} | |
74 | ||
75 | Creates a resource from a node. | |
76 | ||
77 | \membersection{wxXmlResourceHandler::CreateResource}\label{wxxmlresourcehandlercreateresource} | |
78 | ||
79 | \func{wxObject*}{CreateResource}{\param{wxXmlNode* }{node}, \param{wxObject* }{parent}, \param{wxObject* }{instance}} | |
80 | ||
81 | Creates an object (menu, dialog, control, ...) from an XML node. | |
82 | Should check for validity. {\it parent} is a higher-level object (usually window, dialog or panel) | |
83 | that is often neccessary to create the resource. | |
84 | If {\bf instance} is non-NULL it should not create a new instance via 'new' but | |
85 | should rather use this one, and call its Create method. | |
86 | ||
87 | \membersection{wxXmlResourceHandler::DoCreateResource}\label{wxxmlresourcehandlerdocreateresource} | |
88 | ||
89 | \func{wxObject*}{DoCreateResource}{\void} | |
90 | ||
91 | Called from CreateResource after variables | |
92 | were filled. | |
93 | ||
94 | \membersection{wxXmlResourceHandler::GetBitmap}\label{wxxmlresourcehandlergetbitmap} | |
95 | ||
96 | \func{wxBitmap}{GetBitmap}{\param{const wxString\& }{param = wxT("bitmap")}, \param{wxSize }{size = wxDefaultSize}} | |
97 | ||
98 | Gets a bitmap. | |
99 | ||
100 | \membersection{wxXmlResourceHandler::GetBool}\label{wxxmlresourcehandlergetbool} | |
101 | ||
102 | \func{bool}{GetBool}{\param{const wxString\& }{param}, \param{bool }{defaultv = FALSE}} | |
103 | ||
104 | Gets a bool flag (1, t, yes, on, true are TRUE, everything else is FALSE). | |
105 | ||
106 | \membersection{wxXmlResourceHandler::GetColour}\label{wxxmlresourcehandlergetcolour} | |
107 | ||
108 | \func{wxColour}{GetColour}{\param{const wxString\& }{param}} | |
109 | ||
110 | Gets colour in HTML syntax (\#RRGGBB). | |
111 | ||
112 | \membersection{wxXmlResourceHandler::GetCurFileSystem}\label{wxxmlresourcehandlergetcurfilesystem} | |
113 | ||
114 | \func{wxFileSystem\&}{GetCurFileSystem}{\void} | |
115 | ||
116 | Returns the current file system. | |
117 | ||
118 | \membersection{wxXmlResourceHandler::GetDimension}\label{wxxmlresourcehandlergetdimension} | |
119 | ||
120 | \func{wxCoord}{GetDimension}{\param{const wxString\& }{param}, \param{wxCoord }{defaultv = 0}} | |
121 | ||
122 | Gets a dimension (may be in dialog units). | |
123 | ||
124 | \membersection{wxXmlResourceHandler::GetFont}\label{wxxmlresourcehandlergetfont} | |
125 | ||
126 | \func{wxFont}{GetFont}{\param{const wxString\& }{param = wxT("font")}} | |
127 | ||
128 | Gets a font. | |
129 | ||
130 | \membersection{wxXmlResourceHandler::GetID}\label{wxxmlresourcehandlergetid} | |
131 | ||
132 | \func{int}{GetID}{\void} | |
133 | ||
134 | Returns the XRCID. | |
135 | ||
136 | \membersection{wxXmlResourceHandler::GetIcon}\label{wxxmlresourcehandlergeticon} | |
137 | ||
138 | \func{wxIcon}{GetIcon}{\param{const wxString\& }{param = wxT("icon")}, \param{wxSize }{size = wxDefaultSize}} | |
139 | ||
140 | Returns an icon. | |
141 | ||
142 | \membersection{wxXmlResourceHandler::GetLong}\label{wxxmlresourcehandlergetlong} | |
143 | ||
144 | \func{long}{GetLong}{\param{const wxString\& }{param}, \param{long }{defaultv = 0}} | |
145 | ||
146 | Gets the integer value from the parameter. | |
147 | ||
148 | \membersection{wxXmlResourceHandler::GetName}\label{wxxmlresourcehandlergetname} | |
149 | ||
150 | \func{wxString}{GetName}{\void} | |
151 | ||
152 | Returns the resource name. | |
153 | ||
154 | \membersection{wxXmlResourceHandler::GetNodeContent}\label{wxxmlresourcehandlergetnodecontent} | |
155 | ||
156 | \func{wxString}{GetNodeContent}{\param{wxXmlNode* }{node}} | |
157 | ||
158 | Gets node content from wxXML\_ENTITY\_NODE. | |
159 | ||
160 | \membersection{wxXmlResourceHandler::GetParamNode}\label{wxxmlresourcehandlergetparamnode} | |
161 | ||
162 | \func{wxXmlNode*}{GetParamNode}{\param{const wxString\& }{param}} | |
163 | ||
164 | Finds the node or returns NULL. | |
165 | ||
166 | \membersection{wxXmlResourceHandler::GetParamValue}\label{wxxmlresourcehandlergetparamvalue} | |
167 | ||
168 | \func{wxString}{GetParamValue}{\param{const wxString\& }{param}} | |
169 | ||
170 | Finds the parameter value or returns the empty string. | |
171 | ||
172 | \membersection{wxXmlResourceHandler::GetPosition}\label{wxxmlresourcehandlergetposition} | |
173 | ||
174 | \func{wxPoint}{GetPosition}{\param{const wxString\& }{param = wxT("pos")}} | |
175 | ||
176 | Gets the position (may be in dialog units). | |
177 | ||
178 | \membersection{wxXmlResourceHandler::GetSize}\label{wxxmlresourcehandlergetsize} | |
179 | ||
180 | \func{wxSize}{GetSize}{\param{const wxString\& }{param = wxT("size")}} | |
181 | ||
182 | Gets the size (may be in dialog units). | |
183 | ||
184 | \membersection{wxXmlResourceHandler::GetStyle}\label{wxxmlresourcehandlergetstyle} | |
185 | ||
186 | \func{int}{GetStyle}{\param{const wxString\& }{param = wxT("style")}, \param{int }{defaults = 0}} | |
187 | ||
188 | Gets style flags from text in form "flag | flag2| flag3 |..." | |
189 | Only understands flags added with AddStyle. | |
190 | ||
191 | \membersection{wxXmlResourceHandler::GetText}\label{wxxmlresourcehandlergettext} | |
192 | ||
193 | \func{wxString}{GetText}{\param{const wxString\& }{param}} | |
194 | ||
195 | Gets text from param and does some conversions: | |
196 | ||
197 | \begin{itemize}\itemsep=0pt | |
198 | \item replaces $\backslash$n, $\backslash$r, $\backslash$t by respective characters (according to C syntax) | |
199 | \item replaces \verb+$+ by \verb+\&+ and \verb+\$\$+ by \verb+\$+ (needed for \verb+\$File+ to \verb+\&File+ | |
200 | translation because of XML syntax) | |
201 | \item calls wxGetTranslations (unless disabled in wxXmlResource) | |
202 | \end{itemize} | |
203 | ||
204 | \membersection{wxXmlResourceHandler::HasParam}\label{wxxmlresourcehandlerhasparam} | |
205 | ||
206 | \func{bool}{HasParam}{\param{const wxString\& }{param}} | |
207 | ||
208 | Check to see if a parameter exists. | |
209 | ||
210 | \membersection{wxXmlResourceHandler::IsOfClass}\label{wxxmlresourcehandlerisofclass} | |
211 | ||
212 | \func{bool}{IsOfClass}{\param{wxXmlNode* }{node}, \param{const wxString\& }{classname}} | |
213 | ||
214 | Convenience function. Returns true if the node has a property class equal to classname, | |
215 | e.g. <object class="wxDialog">. | |
216 | ||
217 | \membersection{wxXmlResourceHandler::SetParentResource}\label{wxxmlresourcehandlersetparentresource} | |
218 | ||
219 | \func{void}{SetParentResource}{\param{wxXmlResource* }{res}} | |
220 | ||
221 | Sets the parent resource. | |
222 | ||
223 | \membersection{wxXmlResourceHandler::SetupWindow}\label{wxxmlresourcehandlersetupwindow} | |
224 | ||
225 | \func{void}{SetupWindow}{\param{wxWindow* }{wnd}} | |
226 | ||
227 | Sets common window options. | |
228 |