.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxXmlResourceHandler 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxXmlResourceHandler \- 
  The base class for XML resource handlers.
 
.SH DESCRIPTION

  


   wxXmlResourceHandler is an abstract base class for resource handlers capable
   of creating a control from an XML node.
  
  


   See
   XML-based resource system overview
   for details.
  
 
.SH "PARENTS"

  wxObject
 
.SH "INCLUDE FILES"
wx/xrc/xmlres.h
.SH MEMBERS

  
.SS  wxXmlResourceHandler ()

     


      Default constructor.
     
    
   
  
.SS  ~wxXmlResourceHandler ()

     


      Destructor.
     
    
   
  
.SS void AddStyle (const wxString& nameint value)

     


      Add a style flag (e.g. wxMB_DOCKABLE) to the list of flags understood by
      this handler.
     
    
   
  
.SS void AddWindowStyles ()

     


      Add styles common to all wxWindow-derived classes.
     
    
   
  
.SS bool CanHandle (wxXmlNode* node)

     


      Returns true if it understands this node and can create a resource from
      it, false otherwise.
     
    
   
  
.SS void CreateChildren (wxObject* parentbool this_hnd_only = false)

     


      Creates children.
     
    
   
  
.SS void CreateChildrenPrivately (wxObject* parentwxXmlNode* rootnode = NULL)

     


      Helper function.
     
    
   
  
.SS wxObject* CreateResFromNode (wxXmlNode* nodewxObject* parentwxObject* instance = NULL)

     


      Creates a resource from a node.
     
    
   
  
.SS wxObject* CreateResource (wxXmlNode* nodewxObject* parentwxObject* 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.
     
    
   
  
.SS wxObject* DoCreateResource ()

     


      Called from CreateResource after variables were filled.
     
    
   
  
.SS wxBitmap GetBitmap (const wxString& param = wxT("bitmap")wxSize size = wxDefaultSize)

     


      Gets a bitmap.
     
    
   
  
.SS bool GetBool (const wxString& parambool defaultv = false)

     


      Gets a bool flag (1, t, yes, on, true are true, everything else is false).
     
    
   
  
.SS wxColour GetColour (const wxString& param)

     


      Gets colour in HTML syntax (#RRGGBB).
     
    
   
  
.SS wxFileSystem& GetCurFileSystem ()

     


      Returns the current file system.
     
    
   
  
.SS wxCoord GetDimension (const wxString& paramwxCoord defaultv = 0)

     


      Gets a dimension (may be in dialog units).
     
    
   
  
.SS wxFont GetFont (const wxString& param = wxT("font"))

     


      Gets a font.
     
    
   
  
.SS int GetID ()

     


      Returns the XRCID.
     
    
   
  
.SS wxIcon GetIcon (const wxString& param = wxT("icon")wxSize size = wxDefaultSize)

     


      Returns an icon.
     
    
   
  
.SS long GetLong (const wxString& paramlong defaultv = 0)

     


      Gets the integer value from the parameter.
     
    
   
  
.SS wxString GetName ()

     


      Returns the resource name.
     
    
   
  
.SS wxString GetNodeContent (wxXmlNode* node)

     


      Gets node content from wxXML_ENTITY_NODE.
     
    
   
  
.SS wxXmlNode* GetParamNode (const wxString& param)

     


      Finds the node or returns NULL.
     
    
   
  
.SS wxString GetParamValue (const wxString& param)

     


      Finds the parameter value or returns the empty string.
     
    
   
  
.SS wxPoint GetPosition (const wxString& param = wxT("pos"))

     


      Gets the position (may be in dialog units).
     
    
   
  
.SS wxSize GetSize (const wxString& param = wxT("size"))

     


      Gets the size (may be in dialog units).
     
    
   
  
.SS int GetStyle (const wxString& param = wxT("style")int defaults = 0)

     


      Gets style flags from text in form "flag | flag2| flag3 |..."
      Only understands flags added with AddStyle.
     
    
   
  
.SS wxString GetText (const wxString& param)

     


      Gets text from param and does some conversions:
     
     


      
       replaces \backslashn, \backslashr, \backslasht by respective characters
        (according to C syntax)
        
       replaces
        $
        by
        &
        and
        
        by
        $
        (needed for
        _File
        to
        &File
        translation because of XML syntax)
        
       calls wxGetTranslations (unless disabled in wxXmlResource)
      
     
    
   
  
.SS bool HasParam (const wxString& param)

     


      Check to see if a parameter exists.
     
    
   
  
.SS bool IsOfClass (wxXmlNode* nodeconst wxString& classname)

     


      Convenience function. Returns true if the node has a property class equal
      to classname, e.g. <object class="wxDialog">.
     
    
   
  
.SS void SetParentResource (wxXmlResource* res)

     


      Sets the parent resource.
     
    
   
  
.SS void SetupWindow (wxWindow* wnd)

     


      Sets common window options.
     
    
 
.SH "SEE ALSO"

  wxObject
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.