wxXmlResourceThis 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 XML-based resource system overview for details. Derived from Include files <wx/xrc/xmlres.h> Constants
enum wxXmlResourceFlags { wxXRC_USE_LOCALE = 1, wxXRC_NO_SUBCLASSING = 2, wxXRC_NO_RELOADING = 4 };Members
wxXmlResource::wxXmlResource
wxXmlResource::wxXmlResourcewxXmlResource(const wxString& filemask, int flags = wxXRC_USE_LOCALE, const wxStringdomain = wxEmptyString) Constructor. filemask
flags
domain
wxXmlResource(int flags = wxXRC_USE_LOCALE, const wxStringdomain = wxEmptyString) Constructor. flags
domain
wxXmlResource::~wxXmlResource~wxXmlResource() Destructor.
wxXmlResource::AddHandlervoid AddHandler(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 ClearHandlers later.
wxXmlResource::AttachUnknownControlbool AttachUnknownControl(const wxString& name, wxWindow* control, wxWindow* parent = NULL) Attaches an unknown control to the given panel/window/dialog. Unknown controls are used in conjunction with <object class="unknown">.
wxXmlResource::ClearHandlersvoid ClearHandlers() Removes all handlers and deletes them (this means that any handlers added using AddHandler must be allocated on the heap).
wxXmlResource::CompareVersionint CompareVersion(int major, int minor, int release, int revision) const 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.
wxXmlResource::GetwxXmlResource* Get() Gets the global resources object or creates one if none exists.
wxXmlResource::GetFlagsint GetFlags() Returns flags, which may be a bitlist of wxXRC_USE_LOCALE and wxXRC_NO_SUBCLASSING.
wxXmlResource::GetVersionlong GetVersion() const Returns version information (a.b.c.d = d+ 256*c + 2562*b + 2563*a).
wxXmlResource::GetXRCIDint GetXRCID(const wxChar* str_id, 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 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 value_if_not_found is wxID_NONE, the number is obtained via wxNewId(). Otherwise value_if_not_found is used. Macro XRCID(name) is provided for convenient use in event tables.
wxXmlResource::InitAllHandlersvoid InitAllHandlers() Initializes handlers for all supported controls/windows. This will make the executable quite big because it forces linking against most of the wxWidgets library.
wxXmlResource::Loadbool Load(const wxString& filemask) Loads resources from XML files that match given filemask. This method understands VFS (see filesys.h).
wxXmlResource::LoadBitmapwxBitmap LoadBitmap(const wxString& name) Loads a bitmap resource from a file.
wxXmlResource::LoadDialogwxDialog* LoadDialog(wxWindow* parent, const wxString& name) Loads a dialog. dlg points to a parent window (if any). bool LoadDialog(wxDialog* dlg, wxWindow* parent, const wxString& name) Loads a dialog. 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:
MyDialog dlg; wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog"); dlg.ShowModal(); wxXmlResource::LoadFramebool LoadFrame(wxFrame* frame, wxWindow* parent, const wxString& name) Loads a frame.
wxXmlResource::LoadIconwxIcon LoadIcon(const wxString& name) Loads an icon resource from a file.
wxXmlResource::LoadMenuwxMenu* LoadMenu(const wxString& name) Loads menu from resource. Returns NULL on failure.
wxXmlResource::LoadMenuBarwxMenuBar* LoadMenuBar(wxWindow* parent, const wxString& name) Loads a menubar from resource. Returns NULL on failure. wxMenuBar* LoadMenuBar(const wxString& name) Loads a menubar from resource. Returns NULL on failure.
wxXmlResource::LoadPanelwxPanel* LoadPanel(wxWindow* parent, const wxString& name) Loads a panel. panel points to parent window (if any). bool LoadPanel(wxPanel* panel, wxWindow* parent, const wxString& name) Loads a panel. panel points to parent window (if any). This form is used to finish creation of an already existing instance.
wxXmlResource::LoadToolBarwxToolBar* LoadToolBar(wxWindow* parent, const wxString& name) Loads a toolbar.
wxXmlResource::SetwxXmlResource* Set(wxXmlResource* res) Sets the global resources object and returns a pointer to the previous one (may be NULL).
wxXmlResource::SetFlagsvoid SetFlags(int flags) Sets flags (bitlist of wxXRC_USE_LOCALE and wxXRC_NO_SUBCLASSING).
wxXmlResource::Unloadbool Unload(const wxString& filename) This function unloads a resource previously loaded by Load(). Returns true if the resource was successfully unloaded and false if it hasn't been found in the list of loaded resources.
wxXmlResource::GetDomainwxChar* GetDomain() Returns the domain (message catalog) that will be used to load translatable strings in the XRC.
wxXmlResource::SetDomainwxChar* SetDomain(const wxChar* domain) Sets the domain (message catalog) that will be used to load translatable strings in the XRC.
|