#include <wx/xrc/xmlres.h>
wxSizerXmlHandler is a class for resource handlers capable of creating a wxSizer object from an XML node.
wxXmlResourceHandler is an abstract base class for resource handlers capable of creating a control from an XML node.
<>< =''>:</>&;&;< =''>\ </></>
See XML Based Resource System (XRC) for details.
<>< =''>:</>&;&;< =''>\ </></>
Public Member Functions | |
wxXmlResourceHandler () | |
Default constructor. | |
virtual | ~wxXmlResourceHandler () |
Destructor. | |
wxObject * | CreateResource (wxXmlNode *node, wxObject *parent, wxObject *instance) |
Creates an object (menu, dialog, control, ...) from an XML node. | |
virtual wxObject * | DoCreateResource ()=0 |
Called from CreateResource after variables were filled. | |
virtual bool | CanHandle (wxXmlNode *node)=0 |
Returns true if it understands this node and can create a resource from it, false otherwise. | |
void | SetParentResource (wxXmlResource *res) |
Sets the parent resource. | |
![]() | |
wxObject () | |
Default ctor; initializes to NULL the internal reference data. | |
wxObject (const wxObject &other) | |
Copy ctor. | |
virtual | ~wxObject () |
Destructor. | |
virtual wxClassInfo * | GetClassInfo () const |
This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). | |
wxObjectRefData * | GetRefData () const |
Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. | |
bool | IsKindOf (const wxClassInfo *info) const |
Determines whether this class is a subclass of (or the same class as) the given class. | |
bool | IsSameAs (const wxObject &obj) const |
Returns true if this object has the same data pointer as obj. | |
void | Ref (const wxObject &clone) |
Makes this object refer to the data in clone. | |
void | SetRefData (wxObjectRefData *data) |
Sets the wxObject::m_refData pointer. | |
void | UnRef () |
Decrements the reference count in the associated data, and if it is zero, deletes the data. | |
void | UnShare () |
This is the same of AllocExclusive() but this method is public. | |
void | operator delete (void *buf) |
The delete operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. | |
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0) |
The new operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. | |
Protected Member Functions | |
void | AddStyle (const wxString &name, int value) |
Add a style flag (e.g. | |
void | AddWindowStyles () |
Add styles common to all wxWindow-derived classes. | |
void | CreateChildren (wxObject *parent, bool this_hnd_only=false) |
Creates children. | |
void | CreateChildrenPrivately (wxObject *parent, wxXmlNode *rootnode=NULL) |
Helper function. | |
wxObject * | CreateResFromNode (wxXmlNode *node, wxObject *parent, wxObject *instance=NULL) |
Creates a resource from a node. | |
wxAnimation * | GetAnimation (const wxString ¶m="animation") |
Creates an animation (see wxAnimation) from the filename specified in param. | |
wxBitmap | GetBitmap (const wxString ¶m="bitmap", const wxArtClient &defaultArtClient=wxART_OTHER, wxSize size=wxDefaultSize) |
Gets a bitmap. | |
wxBitmap | GetBitmap (const wxXmlNode *node, const wxArtClient &defaultArtClient=wxART_OTHER, wxSize size=wxDefaultSize) |
Gets a bitmap from an XmlNode. | |
bool | GetBool (const wxString ¶m, bool defaultv=false) |
Gets a bool flag (1, t, yes, on, true are true, everything else is false). | |
wxColour | GetColour (const wxString ¶m, const wxColour &defaultColour=wxNullColour) |
Gets colour in HTML syntax (#RRGGBB). | |
wxFileSystem & | GetCurFileSystem () |
Returns the current file system. | |
wxCoord | GetDimension (const wxString ¶m, wxCoord defaultv=0, wxWindow *windowToUse=0) |
Gets a dimension (may be in dialog units). | |
wxDirection | GetDirection (const wxString ¶m, wxDirection dirDefault=wxLEFT) |
Gets a direction. | |
wxFont | GetFont (const wxString ¶m="font") |
Gets a font. | |
int | GetID () |
Returns the XRCID. | |
wxIcon | GetIcon (const wxString ¶m="icon", const wxArtClient &defaultArtClient=wxART_OTHER, wxSize size=wxDefaultSize) |
Returns an icon. | |
wxIcon | GetIcon (const wxXmlNode *node, const wxArtClient &defaultArtClient=wxART_OTHER, wxSize size=wxDefaultSize) |
Gets an icon from an XmlNode. | |
wxIconBundle | GetIconBundle (const wxString ¶m, const wxArtClient &defaultArtClient=wxART_OTHER) |
Returns an icon bundle. | |
wxImageList * | GetImageList (const wxString ¶m="imagelist") |
Creates an image list from the param markup data. | |
long | GetLong (const wxString ¶m, long defaultv=0) |
Gets the integer value from the parameter. | |
float | GetFloat (const wxString ¶m, float defaultv=0) |
Gets a float value from the parameter. | |
wxString | GetName () |
Returns the resource name. | |
wxString | GetNodeContent (wxXmlNode *node) |
Gets node content from wxXML_ENTITY_NODE. | |
wxXmlNode * | GetParamNode (const wxString ¶m) |
Finds the node or returns NULL. | |
wxString | GetParamValue (const wxString ¶m) |
Finds the parameter value or returns the empty string. | |
wxString | GetParamValue (const wxXmlNode *node) |
Returns the node parameter value. | |
wxPoint | GetPosition (const wxString ¶m="pos") |
Gets the position (may be in dialog units). | |
wxSize | GetSize (const wxString ¶m="size", wxWindow *windowToUse=0) |
Gets the size (may be in dialog units). | |
int | GetStyle (const wxString ¶m="style", int defaults=0) |
Gets style flags from text in form "flag | flag2| flag3 |..." Only understands flags added with AddStyle(). | |
wxString | GetText (const wxString ¶m, bool translate=true) |
Gets text from param and does some conversions: | |
bool | HasParam (const wxString ¶m) |
Check to see if a parameter exists. | |
bool | IsOfClass (wxXmlNode *node, const wxString &classname) |
Convenience function. | |
void | SetupWindow (wxWindow *wnd) |
Sets common window options. | |
void | ReportError (wxXmlNode *context, const wxString &message) |
Reports error in XRC resources to the user. | |
void | ReportError (const wxString &message) |
Like ReportError(wxXmlNode*, const wxString&), but uses the node of currently processed object (m_node) as the context. | |
void | ReportParamError (const wxString ¶m, const wxString &message) |
Like ReportError(wxXmlNode*, const wxString&), but uses the node of parameter param of the currently processed object as the context. | |
wxXmlResource * | GetResource () const |
After CreateResource has been called this will return the current wxXmlResource object. | |
wxXmlNode * | GetNode () const |
After CreateResource has been called this will return the XML node being processed. | |
wxString | GetClass () const |
After CreateResource has been called this will return the class name of the XML resource node being processed. | |
wxObject * | GetParent () const |
After CreateResource has been called this will return the current item's parent, if any. | |
wxObject * | GetInstance () const |
After CreateResource has been called this will return the instance that the XML resource content should be created upon, if it has already been created. | |
wxWindow * | GetParentAsWindow () const |
After CreateResource has been called this will return the item's parent as a wxWindow. | |
![]() | |
void | AllocExclusive () |
Ensure that this object's data is not shared with any other object. | |
virtual wxObjectRefData * | CreateRefData () const |
Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. | |
virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const |
Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. | |
Additional Inherited Members | |
![]() | |
wxObjectRefData * | m_refData |
Pointer to an object which is the object's reference-counted data. | |
wxXmlResourceHandler::wxXmlResourceHandler | ( | ) |
Default constructor.
|
virtual |
Destructor.
Add a style flag (e.g.
wxMB_DOCKABLE
) to the list of flags understood by this handler.
|
protected |
Add styles common to all wxWindow-derived classes.
Returns true if it understands this node and can create a resource from it, false otherwise.
Implemented in wxSizerXmlHandler.
|
protected |
Creates children.
|
protected |
Helper function.
|
protected |
Creates a resource from a node.
wxObject * wxXmlResourceHandler::CreateResource | ( | wxXmlNode * | node, |
wxObject * | parent, | ||
wxObject * | instance | ||
) |
Creates an object (menu, dialog, control, ...) from an XML node.
Should check for validity. parent is a higher-level object (usually window, dialog or panel) that is often necessary to create the resource.
If instance is non-NULL it should not create a new instance via 'new' but should rather use this one, and call its Create method.
Called from CreateResource after variables were filled.
Implemented in wxSizerXmlHandler.
|
protected |
Creates an animation (see wxAnimation) from the filename specified in param.
|
protected |
Gets a bitmap.
|
protected |
Gets a bitmap from an XmlNode.
Gets a bool flag (1, t, yes, on, true are true, everything else is false).
|
protected |
After CreateResource has been called this will return the class name of the XML resource node being processed.
|
protected |
Gets colour in HTML syntax (#RRGGBB).
|
protected |
Returns the current file system.
|
protected |
Gets a dimension (may be in dialog units).
|
protected |
Gets a direction.
If the given param is not present or has empty value, dirDefault is returned by default. Otherwise the value of the parameter is parsed and a warning is generated if it's not one of wxLEFT
, wxTOP
, wxRIGHT
or wxBOTTOM
.
Gets a float value from the parameter.
|
protected |
Returns an icon.
|
protected |
Gets an icon from an XmlNode.
|
protected |
Returns an icon bundle.
|
protected |
Returns the XRCID.
|
protected |
Creates an image list from the param markup data.
|
protected |
After CreateResource has been called this will return the instance that the XML resource content should be created upon, if it has already been created.
If NULL then the handler should create the object itself.
Gets the integer value from the parameter.
|
protected |
Returns the resource name.
|
protected |
After CreateResource has been called this will return the XML node being processed.
Gets node content from wxXML_ENTITY_NODE.
Finds the node or returns NULL.
Finds the parameter value or returns the empty string.
Returns the node parameter value.
|
protected |
After CreateResource has been called this will return the current item's parent, if any.
|
protected |
After CreateResource has been called this will return the item's parent as a wxWindow.
Gets the position (may be in dialog units).
|
protected |
After CreateResource has been called this will return the current wxXmlResource object.
|
protected |
Gets the size (may be in dialog units).
Gets style flags from text in form "flag | flag2| flag3 |..." Only understands flags added with AddStyle().
Gets text from param and does some conversions:
$
by and
$$
by $
(needed for _File
to File
translation because of XML syntax)Check to see if a parameter exists.
Convenience function.
Returns true if the node has a property class equal to classname, e.g. object class="wxDialog".
Like ReportError(wxXmlNode*, const wxString&), but uses the node of currently processed object (m_node) as the context.
Reports error in XRC resources to the user.
See wxXmlResource::ReportError() for more information.
|
protected |
Like ReportError(wxXmlNode*, const wxString&), but uses the node of parameter param of the currently processed object as the context.
This is convenience function for reporting errors in particular parameters.
void wxXmlResourceHandler::SetParentResource | ( | wxXmlResource * | res | ) |
Sets the parent resource.