X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1f6ea93556fb59e6d8f50af1f36ddb16b5a0dc33..36a0190ebd5bd9a7302f60f6dcd608b80574e21c:/interface/wx/xrc/xmlres.h?ds=inline diff --git a/interface/wx/xrc/xmlres.h b/interface/wx/xrc/xmlres.h index 269aa39ec8..a264d2ab39 100644 --- a/interface/wx/xrc/xmlres.h +++ b/interface/wx/xrc/xmlres.h @@ -2,7 +2,6 @@ // Name: xrc/xmlres.h // Purpose: interface of wxXmlResource // Author: wxWidgets team -// RCS-ID: $Id$ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -89,6 +88,12 @@ public: */ void AddHandler(wxXmlResourceHandler* handler); + /** + Add a new handler at the begining of the handler list. + */ + void InsertHandler(wxXmlResourceHandler *handler); + + /** Attaches an unknown control to the given panel/window/dialog. Unknown controls are used in conjunction with \. @@ -103,6 +108,14 @@ public: */ void ClearHandlers(); + /** + Registers subclasses factory for use in XRC. This is useful only for + language bindings developers who need a way to implement subclassing in + wxWidgets ports that don't support wxRTTI (e.g. wxPython). + */ + static void AddSubclassFactory(wxXmlSubclassFactory *factory); + + /** Compares the XRC version to the argument. @@ -260,7 +273,16 @@ public: bool LoadDialog(wxDialog* dlg, wxWindow* parent, const wxString& name); /** - Loads a frame. + Loads a frame from the resource. @a parent points to parent window (if any). + */ + wxFrame *LoadFrame(wxWindow* parent, const wxString& name); + + /** + 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). */ bool LoadFrame(wxFrame* frame, wxWindow* parent, const wxString& name); @@ -514,7 +536,7 @@ protected: /** Creates an animation (see wxAnimation) from the filename specified in @a param. */ - wxAnimation GetAnimation(const wxString& param = "animation"); + wxAnimation* GetAnimation(const wxString& param = "animation"); /** Gets a bitmap. @@ -553,6 +575,18 @@ protected: wxCoord GetDimension(const wxString& param, wxCoord defaultv = 0, wxWindow* windowToUse = 0); + /** + Gets a direction. + + If the given @a param is not present or has empty value, @a dir is + returned by default. Otherwise the value of the parameter is parsed and + a warning is generated if it's not one of @c wxLEFT, @c wxTOP, @c + wxRIGHT or @c wxBOTTOM. + + @since 2.9.3 + */ + wxDirection GetDirection(const wxString& param, wxDirection dir = wxLEFT); + /** Gets a font. */ @@ -600,13 +634,18 @@ protected: @since 2.9.1 */ - wxImageList *GetImageList(const wxString& param = wxT("imagelist")); + wxImageList *GetImageList(const wxString& param = "imagelist"); /** Gets the integer value from the parameter. */ long GetLong(const wxString& param, long defaultv = 0); + /** + Gets a float value from the parameter. + */ + float GetFloat(const wxString& param, float defaultv = 0); + /** Returns the resource name. */ @@ -702,5 +741,55 @@ protected: @since 2.9.0 */ void ReportParamError(const wxString& param, const wxString& message); + + + /** + After CreateResource has been called this will return the current + wxXmlResource object. + + @since 2.9.5 + */ + wxXmlResource* GetResource() const; + + /** + After CreateResource has been called this will return the XML node + being processed. + + @since 2.9.5 + */ + wxXmlNode* GetNode() const; + + /** + After CreateResource has been called this will return the class name of + the XML resource node being processed. + + @since 2.9.5 + */ + wxString GetClass() const; + + /** + After CreateResource has been called this will return the current + item's parent, if any. + + @since 2.9.5 + */ + wxObject* GetParent() 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. If @NULL then the handler should create the object itself. + + @since 2.9.5 + */ + wxObject* GetInstance() const; + + /** + After CreateResource has been called this will return the item's parent + as a wxWindow. + + @since 2.9.5 + */ + wxWindow* GetParentAsWindow() const; };