corrected EVT_NOTIFY[_RANGE] docs (bug 1439078)

[wxWidgets.git] / docs / latex / wx / xmlres.tex

%
% automatically generated by HelpGen $Revision$ from
% xmlres.h at 22/Jan/02 23:08:28
%

\section{\class{wxXmlResource}}\label{wxxmlresource}

This is the main class for interacting with the XML-based resource system.

The class holds XML resources from one or more .xml files, binary files or zip archive files.

See \helpref{XML-based resource system overview}{xrcoverview} for details.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/xrc/xmlres.h>

\wxheading{Constants}

\begin{verbatim}
enum wxXmlResourceFlags
{
    wxXRC_USE_LOCALE     = 1,
    wxXRC_NO_SUBCLASSING = 2,
    wxXRC_NO_RELOADING   = 4
};
\end{verbatim}

\latexignore{\rtfignore{\wxheading{Members}}}


\membersection{wxXmlResource::wxXmlResource}\label{wxxmlresourcector}

\func{}{wxXmlResource}{\param{const wxString\& }{filemask}, 
    \param{int }{flags = wxXRC\_USE\_LOCALE},
    \param{const wxString& }{domain = wxEmptyString}}

Constructor.

\docparam{filemask}{The XRC file, archive file, or wildcard specification that will be used to
load all resource files inside a zip archive.}

\docparam{flags}{wxXRC\_USE\_LOCALE: translatable strings will be translated via \_().
wxXRC\_NO\_SUBCLASSING: subclass property of object nodes will be ignored
(useful for previews in XRC editors).}

\docparam{domain}{The name of the gettext catalog to search for
  translatable strings.  By default all loaded catalogs will be
  searched.  This provides a way to allow the strings to only come
  from a specific catalog.}

\func{}{wxXmlResource}{\param{int }{flags = wxXRC\_USE\_LOCALE},
    \param{const wxString& }{domain = wxEmptyString}}

Constructor.

\docparam{flags}{wxXRC\_USE\_LOCALE: translatable strings will be translated via \_().
wxXRC\_NO\_SUBCLASSING: subclass property of object nodes will be ignored
(useful for previews in XRC editors). wxXRC\_NO\_RELOADING will prevent the
XRC files from being reloaded from disk in case they have been modified there
since being last loaded (may slightly speed up loading them).}

\docparam{domain}{The name of the gettext catalog to search for
  translatable strings.  By default all loaded catalogs will be
  searched.  This provides a way to allow the strings to only come
  from a specific catalog.}


\membersection{wxXmlResource::\destruct{wxXmlResource}}\label{wxxmlresourcedtor}

\func{}{\destruct{wxXmlResource}}{\void}

Destructor.


\membersection{wxXmlResource::AddHandler}\label{wxxmlresourceaddhandler}

\func{void}{AddHandler}{\param{wxXmlResourceHandler* }{handler}}

Initializes only a specific handler (or custom handler). Convention says
that the handler name is equal to the control's name plus 'XmlHandler', for example
wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. The XML resource compiler
(wxxrc) can create include file that contains initialization code for
all controls used within the resource. Note that this handler should be
allocated on the heap, since it will be delete by 
\helpref{ClearHandlers}{wxxmlresourceclearhandlers} later.


\membersection{wxXmlResource::AttachUnknownControl}\label{wxxmlresourceattachunknowncontrol}

\func{bool}{AttachUnknownControl}{\param{const wxString\& }{name}, \param{wxWindow* }{control}, \param{wxWindow* }{parent = NULL}}

Attaches an unknown control to the given panel/window/dialog.
Unknown controls are used in conjunction with <object class="unknown">.


\membersection{wxXmlResource::ClearHandlers}\label{wxxmlresourceclearhandlers}

\func{void}{ClearHandlers}{\void}

Removes all handlers and deletes them (this means that any handlers added using 
\helpref{AddHandler}{wxxmlresourceaddhandler} must be allocated on the heap).


\membersection{wxXmlResource::CompareVersion}\label{wxxmlresourcecompareversion}

\constfunc{int}{CompareVersion}{\param{int }{major}, \param{int }{minor}, \param{int }{release}, \param{int }{revision}}

Compares the XRC version to the argument. Returns -1 if the XRC version
is less than the argument, +1 if greater, and 0 if they equal.


\membersection{wxXmlResource::Get}\label{wxxmlresourceget}

\func{wxXmlResource*}{Get}{\void}

Gets the global resources object or creates one if none exists.


\membersection{wxXmlResource::GetFlags}\label{wxxmlresourcegetflags}

\func{int}{GetFlags}{\void}

Returns flags, which may be a bitlist of wxXRC\_USE\_LOCALE and wxXRC\_NO\_SUBCLASSING.


\membersection{wxXmlResource::GetVersion}\label{wxxmlresourcegetversion}

\constfunc{long}{GetVersion}{\void}

Returns version information (a.b.c.d = d+ 256*c + 256\textasciicircum2*b + 256\textasciitilde3*a).


\membersection{wxXmlResource::GetXRCID}\label{wxxmlresourcegetxmlid}

\func{int}{GetXRCID}{\param{const wxChar* }{str\_id}, \param{int }{value\_if\_not\_found = -2}}

Returns a numeric ID that is equivalent to the string ID used in an XML
resource. If an unknown \arg{str\_id} is requested (i.e. other than wxID\_XXX
or integer), a new record is created which associates the given string with
a number. If \arg{value\_if\_not\_found} is \texttt{wxID\_NONE}, the number is obtained via
\helpref{wxNewId()}{wxnewid}. Otherwise \arg{value\_if\_not\_found} is used.
Macro {\tt XRCID(name)} is provided for convenient use in event tables.

\membersection{wxXmlResource::InitAllHandlers}\label{wxxmlresourceinitallhandlers}

\func{void}{InitAllHandlers}{\void}

Initializes handlers for all supported controls/windows. This will
make the executable quite big because it forces linking against
most of the wxWidgets library.


\membersection{wxXmlResource::Load}\label{wxxmlresourceload}

\func{bool}{Load}{\param{const wxString\& }{filemask}}

Loads resources from XML files that match given filemask.
This method understands VFS (see filesys.h).


\membersection{wxXmlResource::LoadBitmap}\label{wxxmlresourceloadbitmap}

\func{wxBitmap}{LoadBitmap}{\param{const wxString\& }{name}}

Loads a bitmap resource from a file.


\membersection{wxXmlResource::LoadDialog}\label{wxxmlresourceloaddialog}

\func{wxDialog*}{LoadDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}

Loads a dialog. {\it dlg} points to a parent window (if any).

\func{bool}{LoadDialog}{\param{wxDialog* }{dlg}, \param{wxWindow* }{parent}, \param{const wxString\& }{name}}

Loads a dialog. {\it dlg} points to parent window (if any).

This form is used to finish creation of an already existing instance (the main reason
for this is that you may want to use derived class with a new event table).

Example:

\begin{verbatim}
  MyDialog dlg;
  wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog");
  dlg->ShowModal();
\end{verbatim}


\membersection{wxXmlResource::LoadFrame}\label{wxxmlresourceloadframe}

\func{bool}{LoadFrame}{\param{wxFrame* }{frame}, \param{wxWindow* }{parent}, \param{const wxString\& }{name}}

Loads a frame.


\membersection{wxXmlResource::LoadIcon}\label{wxxmlresourceloadicon}

\func{wxIcon}{LoadIcon}{\param{const wxString\& }{name}}

Loads an icon resource from a file.


\membersection{wxXmlResource::LoadMenu}\label{wxxmlresourceloadmenu}

\func{wxMenu*}{LoadMenu}{\param{const wxString\& }{name}}

Loads menu from resource. Returns NULL on failure.


\membersection{wxXmlResource::LoadMenuBar}\label{wxxmlresourceloadmenubar}

\func{wxMenuBar*}{LoadMenuBar}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}

Loads a menubar from resource. Returns NULL on failure.

\func{wxMenuBar*}{LoadMenuBar}{\param{const wxString\& }{name}}

Loads a menubar from resource. Returns NULL on failure.


\membersection{wxXmlResource::LoadPanel}\label{wxxmlresourceloadpanel}

\func{wxPanel*}{LoadPanel}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}

Loads a panel. {\it panel} points to parent window (if any).

\func{bool}{LoadPanel}{\param{wxPanel* }{panel}, \param{wxWindow* }{parent}, \param{const wxString\& }{name}}

Loads a panel. {\it panel} points to parent window (if any). This form
is used to finish creation of an already existing instance.


\membersection{wxXmlResource::LoadToolBar}\label{wxxmlresourceloadtoolbar}

\func{wxToolBar*}{LoadToolBar}{\param{wxWindow* }{parent}, \param{const wxString\& }{name}}

Loads a toolbar.


\membersection{wxXmlResource::Set}\label{wxxmlresourceset}

\func{wxXmlResource*}{Set}{\param{wxXmlResource* }{res}}

Sets the global resources object and returns a pointer to the previous one (may be NULL).


\membersection{wxXmlResource::SetFlags}\label{wxxmlresourcesetflags}

\func{void}{SetFlags}{\param{int }{flags}}

Sets flags (bitlist of wxXRC\_USE\_LOCALE and wxXRC\_NO\_SUBCLASSING).


\membersection{wxXmlResource::Unload}\label{wxxmlresourceunload}

\func{bool}{Unload}{\param{const wxString\& }{filename}}

This function unloads a resource previously loaded by 
\helpref{Load()}{wxxmlresourceload}.

Returns \true if the resource was successfully unloaded and \false if it hasn't
been found in the list of loaded resources.



\membersection{wxXmlResource::GetDomain}\label{wxxmlresourcegetdomain}

\func{wxChar*}{GetDomain}{}

Returns the domain (message catalog) that will be used to load
translatable strings in the XRC.


\membersection{wxXmlResource::SetDomain}\label{wxxmlresourcesetdomain}

\func{wxChar*}{SetDomain}{\param{const wxChar* }{domain}}

Sets the domain (message catalog) that will be used to load
translatable strings in the XRC.