<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year><year>2021</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxXmlResource</title>
</header>
<module>wxXmlResource</module>
<modulesummary>Functions for wxXmlResource class</modulesummary>
<description><p>This is the main class for interacting with the XML-based resource system.
      </p><p>The class holds XML resources from one or more .xml files, binary files or zip archive files.
      </p><p>Note that this is a singleton class and you'll never allocate/deallocate it. Just use the static <seemfa marker="#get/0"><c>get/0</c></seemfa> getter.
      </p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_xrc.html#overview_xrc">Overview xrc</url>, <url href="https://docs.wxwidgets.org/3.1/overview_xrcformat.html#overview_xrcformat">Overview xrcformat</url>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwxXml_resource.html">wxXmlResource</url></p>
  </description>
<datatypes><datatype><name name="wxXmlResource"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>See: <c>new/1</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>Constructor. </fsummary>
    <desc><p>Constructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>Constructor. </fsummary>
    <desc><p>Constructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor. </fsummary>
    <desc><p>Destructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="attachUnknownControl" arity="3" clause_i="1" since=""/>
    <fsummary>See: <c>attachUnknownControl/4</c></fsummary>
  </func>
  
  <func>
    <name name="attachUnknownControl" arity="4" clause_i="1" since=""/>
    <fsummary>Attaches an unknown control to the given panel/window/dialog. </fsummary>
    <desc><p>Attaches an unknown control to the given panel/window/dialog. 
      </p><p>Unknown controls are used in conjunction with &lt;object class="unknown"&gt;. 
      </p></desc>
  </func>
  
  <func>
    <name name="clearHandlers" arity="1" clause_i="1" since=""/>
    <fsummary>Removes all handlers and deletes them (this means that any handlers added using <c>AddHandler()</c> (not implemented in wx) must be allocated on the heap). </fsummary>
    <desc><p>Removes all handlers and deletes them (this means that any handlers added using <c>AddHandler()</c> (not implemented in wx) must be allocated on the heap). 
      </p></desc>
  </func>
  
  <func>
    <name name="compareVersion" arity="5" clause_i="1" since=""/>
    <fsummary>Compares the XRC version to the argument. </fsummary>
    <desc><p>Compares the XRC version to the argument. 
      </p><p>Returns -1 if the XRC version is less than the argument, +1 if greater, and 0 if they are equal. 
      </p></desc>
  </func>
  
  <func>
    <name name="get" arity="0" clause_i="1" since=""/>
    <fsummary>Gets the global resources object or creates one if none exists. </fsummary>
    <desc><p>Gets the global resources object or creates one if none exists. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFlags" arity="1" clause_i="1" since=""/>
    <fsummary>Returns flags, which may be a bitlist of ?wxXmlResourceFlags enumeration values. </fsummary>
    <desc><p>Returns flags, which may be a bitlist of ?wxXmlResourceFlags enumeration values. 
      </p></desc>
  </func>
  
  <func>
    <name name="getVersion" arity="1" clause_i="1" since=""/>
    <fsummary>Returns version information (a.b.c.d = d + 256*c + 2562*b + 2563*a). </fsummary>
    <desc><p>Returns version information (a.b.c.d = d + 256*c + 2562*b + 2563*a). 
      </p></desc>
  </func>
  
  <func>
    <name name="getXRCID" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>getXRCID/2</c></fsummary>
  </func>
  
  <func>
    <name name="getXRCID" arity="2" clause_i="1" since=""/>
    <fsummary>Returns a numeric ID that is equivalent to the string ID used in an XML resource. </fsummary>
    <desc><p>Returns a numeric ID that is equivalent to the string ID used in an XML resource. 
      </p><p>If an unknown <c>str_id</c> is requested (i.e. other than wxID_XXX or integer), a new record is created which associates the given string with a number.
      </p><p>If <c>value_if_not_found</c> is <c>wxID_NONE</c>, the number is obtained via <seemfa marker="wx_misc#newId/0"><c>wx_misc:newId/0</c></seemfa>. Otherwise <c>value_if_not_found</c> is used.
      </p><p>Macro <c>XRCID(name)</c> is provided for convenient use in event tables.
      </p><p>Note: IDs returned by XRCID() cannot be used with the <c>EVT_*_RANGE</c> macros, because the order in which they are assigned to symbolic <c>name</c> values is not guaranteed. 
      </p></desc>
  </func>
  
  <func>
    <name name="initAllHandlers" arity="1" clause_i="1" since=""/>
    <fsummary>Initializes handlers for all supported controls/windows. </fsummary>
    <desc><p>Initializes handlers for all supported controls/windows. 
      </p><p>This will make the executable quite big because it forces linking against most of the wxWidgets library. 
      </p></desc>
  </func>
  
  <func>
    <name name="load" arity="2" clause_i="1" since=""/>
    <fsummary>Loads resources from XML files that match given filemask. </fsummary>
    <desc><p>Loads resources from XML files that match given filemask. 
      </p><p>Example: 
      </p><p>Note: If wxUSE_FILESYS is enabled, this method understands <c>wxFileSystem</c> (not implemented in wx) URLs (see <c>wxFileSystem::FindFirst()</c> (not implemented in wx)).
      </p><p>Note: If you are sure that the argument is name of single XRC file (rather than an URL or a wildcard), use <c>LoadFile()</c> (not implemented in wx) instead.
      </p><p>See: <c>LoadFile()</c> (not implemented in wx), <c>LoadAllFiles()</c> (not implemented in wx)
      </p></desc>
  </func>
  
  <func>
    <name name="loadBitmap" arity="2" clause_i="1" since=""/>
    <fsummary>Loads a bitmap resource from a file. </fsummary>
    <desc><p>Loads a bitmap resource from a file. 
      </p></desc>
  </func>
  
  <func>
    <name name="loadDialog" arity="3" clause_i="1" since=""/>
    <fsummary>Loads a dialog. </fsummary>
    <desc><p>Loads a dialog. 
      </p><p><c>parent</c> points to parent window (if any). 
      </p></desc>
  </func>
  
  <func>
    <name name="loadDialog" arity="4" clause_i="1" since=""/>
    <fsummary>Loads a dialog. </fsummary>
    <desc><p>Loads a dialog. 
      </p><p><c>parent</c> points to parent window (if any).
      </p><p>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:
      </p></desc>
  </func>
  
  <func>
    <name name="loadFrame" arity="3" clause_i="1" since=""/>
    <fsummary>Loads a frame from the resource. </fsummary>
    <desc><p>Loads a frame from the resource. 
      </p><p><c>parent</c> points to parent window (if any). 
      </p></desc>
  </func>
  
  <func>
    <name name="loadFrame" arity="4" clause_i="1" since=""/>
    <fsummary>Loads the contents of a frame onto an existing <c>wxFrame</c>. </fsummary>
    <desc><p>Loads the contents of a frame onto an existing <seeerl marker="wxFrame"><c>wxFrame</c></seeerl>. 
      </p><p>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). 
      </p></desc>
  </func>
  
  <func>
    <name name="loadIcon" arity="2" clause_i="1" since=""/>
    <fsummary>Loads an icon resource from a file. </fsummary>
    <desc><p>Loads an icon resource from a file. 
      </p></desc>
  </func>
  
  <func>
    <name name="loadMenu" arity="2" clause_i="1" since=""/>
    <fsummary>Loads menu from resource. </fsummary>
    <desc><p>Loads menu from resource. 
      </p><p>Returns NULL on failure. 
      </p></desc>
  </func>
  
  <func>
    <name name="loadMenuBar" arity="2" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="loadMenuBar" arity="3" clause_i="1" since=""/>
    <fsummary>Loads a menubar from resource. </fsummary>
    <desc><p>Loads a menubar from resource. 
      </p><p>Returns NULL on failure. 
      </p></desc>
  </func>
  
  <func>
    <name name="loadPanel" arity="3" clause_i="1" since=""/>
    <fsummary>Loads a panel. </fsummary>
    <desc><p>Loads a panel. 
      </p><p><c>parent</c> points to the parent window. 
      </p></desc>
  </func>
  
  <func>
    <name name="loadPanel" arity="4" clause_i="1" since=""/>
    <fsummary>Loads a panel. </fsummary>
    <desc><p>Loads a panel. 
      </p><p><c>parent</c> points to the parent window. This form is used to finish creation of an already existing instance. 
      </p></desc>
  </func>
  
  <func>
    <name name="loadToolBar" arity="3" clause_i="1" since=""/>
    <fsummary>Loads a toolbar. </fsummary>
    <desc><p>Loads a toolbar. 
      </p></desc>
  </func>
  
  <func>
    <name name="set" arity="1" clause_i="1" since=""/>
    <fsummary>Sets the global resources object and returns a pointer to the previous one (may be NULL). </fsummary>
    <desc><p>Sets the global resources object and returns a pointer to the previous one (may be NULL). 
      </p></desc>
  </func>
  
  <func>
    <name name="setFlags" arity="2" clause_i="1" since=""/>
    <fsummary>Sets flags (bitlist of ?wxXmlResourceFlags enumeration values). </fsummary>
    <desc><p>Sets flags (bitlist of ?wxXmlResourceFlags enumeration values). 
      </p></desc>
  </func>
  
  <func>
    <name name="unload" arity="2" clause_i="1" since=""/>
    <fsummary>This function unloads a resource previously loaded by <c>load/2</c>. </fsummary>
    <desc><p>This function unloads a resource previously loaded by <seemfa marker="#load/2"><c>load/2</c></seemfa>. 
      </p><p>Returns true if the resource was successfully unloaded and false if it hasn't been found in the list of loaded resources. 
      </p></desc>
  </func>
  
  <func>
    <name name="xrcctrl" arity="3" clause_i="1" since=""/>
    <fsummary>Looks up a control. </fsummary>
    <desc><p>Looks up a control. 
      </p><p>Get a control with <c>Name</c> in a window created with XML resources. You can use it to set/get values from controls. The object is type casted to <c>Type</c>. Example:  
      </p></desc>
  </func>
  </funcs>
</erlref>
