\begin{itemize}\itemsep=0pt
\item Include the appropriate headers: normally "wx/xrc/xmlres.h" will suffice;
\item If you are going to use \helpref{XRS files}{binaryresourcefiles}, install
-wxFileSystem ZIP handler first with {\tt wxFileSystem::AddHandler(new wxZipFSHandler);}
+wxFileSystem archive handler first with {\tt wxFileSystem::AddHandler(new wxArchiveFSHandler);}
\item call {\tt wxXmlResource::Get()->InitAllHandlers()} from your wxApp::OnInit function,
and then call {\tt wxXmlResource::Get()->Load("myfile.xrc")} to load the resource file;
\item to create a dialog from a resource, create it using the default constructor, and then
dialog editor that you can find in the {\tt wxPython/tools} subdirectory of the wxWidgets
CVS archive;
\item use \urlref{wxGlade}{http://wxglade.sf.net}, a GUI designer written in wxPython. At the moment it can generate Python, C++ and XRC;
-\item convert WIN32 RC files to XRC with the tool in {\tt contrib/utils/convertrc}.
\end{itemize}
A complete list of third-party tools that write to XRC can be found at \urlref{www.wxwidgets.org/lnk\_tool.htm}{http://www.wxwidgets.org/lnk\_tool.htm}.
XRS file is essentially a renamed ZIP archive which means that you can manipulate
it with standard ZIP tools. Note that if you are using XRS files, you have
-to initialize the \helpref{wxFileSystem}{wxfilesystem} ZIP handler first! It is a simple
+to initialize the \helpref{wxFileSystem}{wxfilesystem} archive handler first! It is a simple
thing to do:
\begin{verbatim}
#include <wx/filesys.h>
- #include <wx/fs_zip.h>
+ #include <wx/fs_arc.h>
...
- wxFileSystem::AddHandler(new wxZipFSHandler);
+ wxFileSystem::AddHandler(new wxArchiveFSHandler);
\end{verbatim}
\subsection{Using embedded resources}\label{embeddedresource}
<object class="wxStaticText">
<label>fdgdfgdfgdfg</label>
</object>
- <style>wxSUNKEN_BORDER</style>
+ <style>wxBORDER\_SUNKEN</style>
</object>
<flag>wxALIGN_CENTER</flag>
</object>
<object class="sizeritem" name="dfgdfg">
<object class="wxTextCtrl">
<size>200,200d</size>
- <style>wxTE_MULTILINE|wxSUNKEN_BORDER</style>
+ <style>wxTE_MULTILINE|wxBORDER_SUNKEN</style>
<value>Hello, this is an ordinary multiline\n textctrl....</value>
</object>
<option>1</option>
\end{verbatim}
+It is also possible to access the wxSizerItem of a sizer that is part of
+a resource. This can be done using {\tt XRCSIZERITEM} as shown. The
+resource file can have something like this for a sizer item.
+
+\begin{verbatim}
+<object class="spacer" name="area">
+ <size>400, 300</size>
+</object>
+\end{verbatim}
+
+The code can then access the sizer item by using {\tt XRCSIZERITEM} and
+{\tt XRCID} together.
+
+\begin{verbatim}
+wxSizerItem* item = XRCSIZERITEM(*this, "area");
+\end{verbatim}
+
\subsection{Adding new resource handlers}\label{newresourcehandlers}
-Coming soon.
+Adding a new resource handler is pretty easy.
+Typically, to add an handler for the {\tt MyControl} class, you'll want to create
+the {\tt xh\_mycontrol.h} {\tt xh\_mycontrol.cpp} files.
+
+The header needs to contains the {\tt MyControlXmlHandler} class definition:
+
+\begin{verbatim}
+class MyControlXmlHandler : public wxXmlResourceHandler
+{
+public:
+
+ // Constructor.
+ MyControlXmlHandler();
+
+ // Creates the control and returns a pointer to it.
+ virtual wxObject *DoCreateResource();
+
+ // Returns true if we know how to create a control for the given node.
+ virtual bool CanHandle(wxXmlNode *node);
+
+ // Register with wxWidgets' dynamic class subsystem.
+ DECLARE_DYNAMIC_CLASS(MyControlXmlHandler)
+};
+\end{verbatim}
+
+The implementation of your custom XML handler will typically look as:
+
+\begin{verbatim}
+// Register with wxWidgets' dynamic class subsystem.
+IMPLEMENT_DYNAMIC_CLASS(MyControlXmlHandler, wxXmlResourceHandler)
+
+MyControlXmlHandler::MyControlXmlHandler()
+{
+ // this call adds support for all wxWindows class styles
+ // (e.g. wxBORDER_SIMPLE, wxBORDER_SUNKEN, wxWS_EX_* etc etc)
+ AddWindowStyles();
+
+ // if MyControl class supports e.g. MYCONTROL_DEFAULT_STYLE
+ // you should use:
+ // XRC_ADD_STYLE(MYCONTROL_DEFAULT_STYLE);
+}
+
+wxObject *MyControlXmlHandler::DoCreateResource()
+{
+ // the following macro will init a pointer named "control"
+ // with a new instance of the MyControl class, but will NOT
+ // Create() it!
+ XRC_MAKE_INSTANCE(control, MyControl)
+
+ // this is the point where you'll typically need to do the most
+ // important changes: here the control is created and initialized.
+ // You'll want to use the wxXmlResourceHandler's getters to
+ // do most of your work.
+ // If e.g. the MyControl::Create function looks like:
+ //
+ // bool MyControl::Create(wxWindow *parent, int id,
+ // const wxBitmap &first, const wxPoint &posFirst,
+ // const wxBitmap &second, const wxPoint &posSecond,
+ // const wxString &theTitle, const wxFont &titleFont,
+ // const wxPoint &pos, const wxSize &size,
+ // long style = MYCONTROL_DEFAULT_STYLE,
+ // const wxString &name = wxT("MyControl"));
+ //
+ // then the XRC for your component should look like:
+ //
+ // <object class="MyControl" name="some_name">
+ // <first-bitmap>first.xpm</first-bitmap>
+ // <second-bitmap>text.xpm</second-bitmap>
+ // <first-pos>3,3</first-pos>
+ // <second-pos>4,4</second-pos>
+ // <the-title>a title</the-title>
+ // <title-font>
+ // <!-- the standard XRC tags for describing a font: <size>, <style>, <weight>, etc -->
+ // </title-font>
+ // <!-- XRC also accepts other usual tags for wxWindow-derived classes:
+ // like e.g. <name>, <style>, <size>, <position>, etc -->
+ // </object>
+ //
+ // and the code to read your custom tags from the XRC file is just:
+ control->Create(m_parentAsWindow, GetID(),
+ GetBitmap(wxT("first-bitmap")),
+ GetPosition(wxT("first-pos")),
+ GetBitmap(wxT("second-bitmap")),
+ GetPosition(wxT("second-pos")),
+ GetText(wxT("the-title")),
+ GetFont(wxT("title-font")),
+ GetPosition(), GetSize(), GetStyle(), GetName());
+
+ SetupWindow(control);
+
+ return control;
+}
+
+bool MyControlXmlHandler::CanHandle(wxXmlNode *node)
+{
+ // this function tells XRC system that this handler can parse
+ // the <object class="MyControl"> tags
+ return IsOfClass(node, wxT("MyControl"));
+}
+\end{verbatim}
+
+You may want to check the \helpref{wxXmlResourceHandler}{wxxmlresourcehandler} documentation
+to see how many built-in getters it contains. It's very easy to retrieve also complex structures
+out of XRC files using them.
projects / wxWidgets.git / blobdiff