View Source wxXmlResource (wx v2.4.3)
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.
Note that this is a singleton class and you'll never allocate/deallocate it. Just use the
static get/0 getter.
See:
wxWidgets docs: wxXmlResource
Summary
Functions
Equivalent to attachUnknownControl(This, Name, Control, []).
Attaches an unknown control to the given panel/window/dialog.
Removes all handlers and deletes them (this means that any handlers added using AddHandler()
(not implemented in wx) must be allocated on the heap).
Compares the XRC version to the argument.
Destroys the object
Gets the global resources object or creates one if none exists.
Returns flags, which may be a bitlist of ?wxXmlResourceFlags enumeration values.
Returns version information (a.b.c.d = d + 256c + 2562b + 2563*a).
Equivalent to getXRCID(Str_id, []).
Returns a numeric ID that is equivalent to the string ID used in an XML resource.
Initializes handlers for all supported controls/windows.
Loads resources from XML files that match given filemask.
Loads a bitmap resource from a file.
Loads a dialog.
Loads a dialog.
Loads a frame from the resource.
Loads the contents of a frame onto an existing wxFrame.
Loads an icon resource from a file.
Loads menu from resource.
Loads a menubar from resource.
Loads a panel.
Loads a panel.
Loads a toolbar.
Constructor.
Constructor.
Sets the global resources object and returns a pointer to the previous one (may be NULL).
Sets flags (bitlist of ?wxXmlResourceFlags enumeration values).
This function unloads a resource previously loaded by load/2.
Types
-type wxXmlResource() :: wx:wx_object().
Functions
-spec attachUnknownControl(This, Name, Control) -> boolean() when This :: wxXmlResource(), Name :: unicode:chardata(), Control :: wxWindow:wxWindow().
Equivalent to attachUnknownControl(This, Name, Control, []).
-spec attachUnknownControl(This, Name, Control, [Option]) -> boolean() when This :: wxXmlResource(), Name :: unicode:chardata(), Control :: wxWindow:wxWindow(), Option :: {parent, wxWindow:wxWindow()}.
Attaches an unknown control to the given panel/window/dialog.
Unknown controls are used in conjunction with <object class="unknown">.
-spec clearHandlers(This) -> ok when This :: wxXmlResource().
Removes all handlers and deletes them (this means that any handlers added using AddHandler()
(not implemented in wx) must be allocated on the heap).
-spec compareVersion(This, Major, Minor, Release, Revision) -> integer() when This :: wxXmlResource(), Major :: integer(), Minor :: integer(), Release :: integer(), Revision :: integer().
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 are equal.
-spec destroy(This :: wxXmlResource()) -> ok.
Destroys the object
-spec get() -> wxXmlResource().
Gets the global resources object or creates one if none exists.
-spec getFlags(This) -> integer() when This :: wxXmlResource().
Returns flags, which may be a bitlist of ?wxXmlResourceFlags enumeration values.
-spec getVersion(This) -> integer() when This :: wxXmlResource().
Returns version information (a.b.c.d = d + 256c + 2562b + 2563*a).
-spec getXRCID(Str_id) -> integer() when Str_id :: unicode:chardata().
Equivalent to getXRCID(Str_id, []).
-spec getXRCID(Str_id, [Option]) -> integer() when Str_id :: unicode:chardata(), Option :: {value_if_not_found, integer()}.
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 wx_misc:newId/0. Otherwise value_if_not_found
is used.
Macro XRCID(name) is provided for convenient use in event tables.
Note: IDs returned by XRCID() cannot be used with the EVT_*_RANGE macros, because the
order in which they are assigned to symbolic name values is not guaranteed.
-spec initAllHandlers(This) -> ok when This :: wxXmlResource().
Initializes handlers for all supported controls/windows.
This will make the executable quite big because it forces linking against most of the wxWidgets library.
-spec load(This, Filemask) -> boolean() when This :: wxXmlResource(), Filemask :: unicode:chardata().
Loads resources from XML files that match given filemask.
Example:
Note: If wxUSE_FILESYS is enabled, this method understands wxFileSystem (not
implemented in wx) URLs (see wxFileSystem::FindFirst() (not implemented in wx)).
Note: If you are sure that the argument is name of single XRC file (rather than an URL or
a wildcard), use LoadFile() (not implemented in wx) instead.
-spec loadBitmap(This, Name) -> wxBitmap:wxBitmap() when This :: wxXmlResource(), Name :: unicode:chardata().
Loads a bitmap resource from a file.
-spec loadDialog(This, Parent, Name) -> wxDialog:wxDialog() when This :: wxXmlResource(), Parent :: wxWindow:wxWindow(), Name :: unicode:chardata().
Loads a dialog.
parent points to parent window (if any).
-spec loadDialog(This, Dlg, Parent, Name) -> boolean() when This :: wxXmlResource(), Dlg :: wxDialog:wxDialog(), Parent :: wxWindow:wxWindow(), Name :: unicode:chardata().
Loads a dialog.
parent 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:
-spec loadFrame(This, Parent, Name) -> wxFrame:wxFrame() when This :: wxXmlResource(), Parent :: wxWindow:wxWindow(), Name :: unicode:chardata().
Loads a frame from the resource.
parent points to parent window (if any).
-spec loadFrame(This, Frame, Parent, Name) -> boolean() when This :: wxXmlResource(), Frame :: wxFrame:wxFrame(), Parent :: wxWindow:wxWindow(), Name :: unicode:chardata().
Loads the contents of a frame onto an existing wxFrame.
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).
-spec loadIcon(This, Name) -> wxIcon:wxIcon() when This :: wxXmlResource(), Name :: unicode:chardata().
Loads an icon resource from a file.
-spec loadMenu(This, Name) -> wxMenu:wxMenu() when This :: wxXmlResource(), Name :: unicode:chardata().
Loads menu from resource.
Returns NULL on failure.
-spec loadMenuBar(This, Name) -> wxMenuBar:wxMenuBar() when This :: wxXmlResource(), Name :: unicode:chardata().
-spec loadMenuBar(This, Parent, Name) -> wxMenuBar:wxMenuBar() when This :: wxXmlResource(), Parent :: wxWindow:wxWindow(), Name :: unicode:chardata().
Loads a menubar from resource.
Returns NULL on failure.
-spec loadPanel(This, Parent, Name) -> wxPanel:wxPanel() when This :: wxXmlResource(), Parent :: wxWindow:wxWindow(), Name :: unicode:chardata().
Loads a panel.
parent points to the parent window.
-spec loadPanel(This, Panel, Parent, Name) -> boolean() when This :: wxXmlResource(), Panel :: wxPanel:wxPanel(), Parent :: wxWindow:wxWindow(), Name :: unicode:chardata().
Loads a panel.
parent points to the parent window. This form is used to finish creation of an already
existing instance.
-spec loadToolBar(This, Parent, Name) -> wxToolBar:wxToolBar() when This :: wxXmlResource(), Parent :: wxWindow:wxWindow(), Name :: unicode:chardata().
Loads a toolbar.
-spec new() -> wxXmlResource().
Equivalent to new([]).
-spec new([Option]) -> wxXmlResource() when Option :: {flags, integer()} | {domain, unicode:chardata()}.
Constructor.
-spec new(Filemask, [Option]) -> wxXmlResource() when Filemask :: unicode:chardata(), Option :: {flags, integer()} | {domain, unicode:chardata()}.
Constructor.
-spec set(Res) -> wxXmlResource() when Res :: wxXmlResource().
Sets the global resources object and returns a pointer to the previous one (may be NULL).
-spec setFlags(This, Flags) -> ok when This :: wxXmlResource(), Flags :: integer().
Sets flags (bitlist of ?wxXmlResourceFlags enumeration values).
-spec unload(This, Filename) -> boolean() when This :: wxXmlResource(), Filename :: unicode:chardata().
This function unloads a resource previously loaded by load/2.
Returns true if the resource was successfully unloaded and false if it hasn't been found in the list of loaded resources.
-spec xrcctrl(Window, Name, Type) -> wx:wx_object() when Window :: wxWindow:wxWindow(), Name :: string(), Type :: atom().