docs/latex/wx/xmlres.tex

   1 %
   2 % automatically generated by HelpGen $Revision$ from
   3 % xmlres.h at 22/Jan/02 23:08:28
   4 %
   5
   6 \section{\class{wxXmlResource}}\label{wxxmlresource}
   7
   8 This is the main class for interacting with the XML-based resource system.
   9
  10 The class holds XML resources from one or more .xml files, binary files or zip archive files.
  11
  12 See \helpref{XML-based resource system overview}{xrcoverview} for details.
  13
  14 \wxheading{Derived from}
  15
  16 \helpref{wxObject}{wxobject}
  17
  18 \wxheading{Include files}
  19
  20 <wx/xrc/xmlres.h>
  21
  22 \wxheading{Constants}
  23
  24 \begin{verbatim}
  25 enum wxXmlResourceFlags
  26 {
  27     wxXRC_USE_LOCALE     = 1,
  28     wxXRC_NO_SUBCLASSING = 2,
  29     wxXRC_NO_RELOADING   = 4
  30 };
  31 \end{verbatim}
  32
  33 \latexignore{\rtfignore{\wxheading{Members}}}
  34
  35
  36 \membersection{wxXmlResource::wxXmlResource}\label{wxxmlresourcector}
  37
  38 \func{}{wxXmlResource}{\param{const wxString\& }{filemask}, \param{int }{flags = wxXRC\_USE\_LOCALE}}
  39
  40 Constructor.
  41
  42 \docparam{filemask}{The XRC file, archive file, or wildcard specification that will be used to
  43 load all resource files inside a zip archive.}
  44
  45 \docparam{flags}{wxXRC\_USE\_LOCALE: translatable strings will be translated via \_().
  46 wxXRC\_NO\_SUBCLASSING: subclass property of object nodes will be ignored
  47 (useful for previews in XRC editors).}
  48
  49 \func{}{wxXmlResource}{\param{int }{flags = wxXRC\_USE\_LOCALE}}
  50
  51 Constructor.
  52
  53 \docparam{flags}{wxXRC\_USE\_LOCALE: translatable strings will be translated via \_().
  54 wxXRC\_NO\_SUBCLASSING: subclass property of object nodes will be ignored
  55 (useful for previews in XRC editors). wxXRC\_NO\_RELOADING will prevent the
  56 XRC files from being reloaded from disk in case they have been modified there
  57 since being last loaded (may slightly speed up loading them).}
  58
  59
  60 \membersection{wxXmlResource::\destruct{wxXmlResource}}\label{wxxmlresourcedtor}
  61
  62 \func{}{\destruct{wxXmlResource}}{\void}
  63
  64 Destructor.
  65
  66
  67 \membersection{wxXmlResource::AddHandler}\label{wxxmlresourceaddhandler}
  68
  69 \func{void}{AddHandler}{\param{wxXmlResourceHandler* }{handler}}
  70
  71 Initializes only a specific handler (or custom handler). Convention says
  72 that the handler name is equal to the control's name plus 'XmlHandler', for example
  73 wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. The XML resource compiler
  74 (wxxrc) can create include file that contains initialization code for
  75 all controls used within the resource. Note that this handler should be
  76 located on heap instead of stack, since it will get destroyed on shutdown.
  77
  78
  79 \membersection{wxXmlResource::AttachUnknownControl}\label{wxxmlresourceattachunknowncontrol}
  80
  81 \func{bool}{AttachUnknownControl}{\param{const wxString\& }{name}, \param{wxWindow* }{control}, \param{wxWindow* }{parent = NULL}}
  82
  83 Attaches an unknown control to the given panel/window/dialog.
  84 Unknown controls are used in conjunction with <object class="unknown">.
  85
  86
  87 \membersection{wxXmlResource::ClearHandlers}\label{wxxmlresourceclearhandlers}
  88
  89 \func{void}{ClearHandlers}{\void}
  90
  91 Removes all handlers.
  92
  93
  94 \membersection{wxXmlResource::CompareVersion}\label{wxxmlresourcecompareversion}
  95
  96 \constfunc{int}{CompareVersion}{\param{int }{major}, \param{int }{minor}, \param{int }{release}, \param{int }{revision}}
  97
  98 Compares the XRC version to the argument. Returns -1 if the XRC version
  99 is less than the argument, +1 if greater, and 0 if they equal.
 100
 101
 102 \membersection{wxXmlResource::Get}\label{wxxmlresourceget}
 103
 104 \func{wxXmlResource*}{Get}{\void}
 105
 106 Gets the global resources object or creates one if none exists.
 107
 108
 109 \membersection{wxXmlResource::GetFlags}\label{wxxmlresourcegetflags}
 110
 111 \func{int}{GetFlags}{\void}
 112
 113 Returns flags, which may be a bitlist of wxXRC\_USE\_LOCALE and wxXRC\_NO\_SUBCLASSING.
 114
 115
 116 \membersection{wxXmlResource::GetVersion}\label{wxxmlresourcegetversion}
 117
 118 \constfunc{long}{GetVersion}{\void}
 119
 120 Returns version information (a.b.c.d = d+ 256*c + 256\textasciicircum2*b + 256\textasciitilde3*a).
 121
 122
 123 \membersection{wxXmlResource::GetXRCID}\label{wxxmlresourcegetxmlid}
 124
 125 \func{int}{GetXRCID}{\param{const wxChar* }{str\_id}, \param{int }{value\_if\_not\_found = -2}}
 126
 127 Returns a numeric ID that is equivalent to the string ID used in an XML
 128 resource. If an unknown \arg{str\_id} is requested (i.e. other than wxID\_XXX
 129 or integer), a new record is created which associates the given string with
 130 a number. If \arg{value\_if\_not\_found} is \texttt{wxID\_NONE}, the number is obtained via
 131 \helpref{wxNewId()}{wxnewid}. Otherwise \arg{value\_if\_not\_found} is used.
 132 Macro {\tt XRCID(name)} is provided for convenient use in event tables.
 133
 134 \membersection{wxXmlResource::InitAllHandlers}\label{wxxmlresourceinitallhandlers}
 135
 136 \func{void}{InitAllHandlers}{\void}
 137
 138 Initializes handlers for all supported controls/windows. This will
 139 make the executable quite big because it forces linking against
 140 most of the wxWidgets library.
 141
 142
 143 \membersection{wxXmlResource::Load}\label{wxxmlresourceload}
 144
 145 \func{bool}{Load}{\param{const wxString\& }{filemask}}
 146
 147 Loads resources from XML files that match given filemask.
 148 This method understands VFS (see filesys.h).
 149
 150
 151 \membersection{wxXmlResource::LoadBitmap}\label{wxxmlresourceloadbitmap}
 152
 153 \func{wxBitmap}{LoadBitmap}{\param{const wxString\& }{name}}
 154
 155 Loads a bitmap resource from a file.
 156
 157
 158 \membersection{wxXmlResource::LoadDialog}\label{wxxmlresourceloaddialog}
 159
 160 \func{wxDialog*}{LoadDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 161
 162 Loads a dialog. {\it dlg} points to a parent window (if any).
 163
 164 \func{bool}{LoadDialog}{\param{wxDialog* }{dlg}, \param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 165
 166 Loads a dialog. {\it dlg} points to parent window (if any).
 167
 168 This form is used to finish creation of an already existing instance (the main reason
 169 for this is that you may want to use derived class with a new event table).
 170
 171 Example:
 172
 173 \begin{verbatim}
 174   MyDialog dlg;
 175   wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog");
 176   dlg->ShowModal();
 177 \end{verbatim}
 178
 179
 180 \membersection{wxXmlResource::LoadFrame}\label{wxxmlresourceloadframe}
 181
 182 \func{bool}{LoadFrame}{\param{wxFrame* }{frame}, \param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 183
 184 Loads a frame.
 185
 186
 187 \membersection{wxXmlResource::LoadIcon}\label{wxxmlresourceloadicon}
 188
 189 \func{wxIcon}{LoadIcon}{\param{const wxString\& }{name}}
 190
 191 Loads an icon resource from a file.
 192
 193
 194 \membersection{wxXmlResource::LoadMenu}\label{wxxmlresourceloadmenu}
 195
 196 \func{wxMenu*}{LoadMenu}{\param{const wxString\& }{name}}
 197
 198 Loads menu from resource. Returns NULL on failure.
 199
 200
 201 \membersection{wxXmlResource::LoadMenuBar}\label{wxxmlresourceloadmenubar}
 202
 203 \func{wxMenuBar*}{LoadMenuBar}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 204
 205 Loads a menubar from resource. Returns NULL on failure.
 206
 207 \func{wxMenuBar*}{LoadMenuBar}{\param{const wxString\& }{name}}
 208
 209 Loads a menubar from resource. Returns NULL on failure.
 210
 211
 212 \membersection{wxXmlResource::LoadPanel}\label{wxxmlresourceloadpanel}
 213
 214 \func{wxPanel*}{LoadPanel}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 215
 216 Loads a panel. {\it panel} points to parent window (if any).
 217
 218 \func{bool}{LoadPanel}{\param{wxPanel* }{panel}, \param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 219
 220 Loads a panel. {\it panel} points to parent window (if any). This form
 221 is used to finish creation of an already existing instance.
 222
 223
 224 \membersection{wxXmlResource::LoadToolBar}\label{wxxmlresourceloadtoolbar}
 225
 226 \func{wxToolBar*}{LoadToolBar}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}
 227
 228 Loads a toolbar.
 229
 230
 231 \membersection{wxXmlResource::Set}\label{wxxmlresourceset}
 232
 233 \func{wxXmlResource*}{Set}{\param{wxXmlResource* }{res}}
 234
 235 Sets the global resources object and returns a pointer to the previous one (may be NULL).
 236
 237
 238 \membersection{wxXmlResource::SetFlags}\label{wxxmlresourcesetflags}
 239
 240 \func{void}{SetFlags}{\param{int }{flags}}
 241
 242 Sets flags (bitlist of wxXRC\_USE\_LOCALE and wxXRC\_NO\_SUBCLASSING).
 243
 244
 245 \membersection{wxXmlResource::Unload}\label{wxxmlresourceunload}
 246
 247 \func{bool}{Unload}{\param{const wxString\& }{filename}}
 248
 249 This function unloads a resource previously loaded by
 250 \helpref{Load()}{wxxmlresourceload}.
 251
 252 Returns \true if the resource was successfully unloaded and \false if it hasn't
 253 been found in the list of loaded resources.
 254