X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d2c2afc91be4bdb6e036516785f334ddb54afa0c..13220cca727ed74c2998b4fb89a4d80aacf28e68:/docs/latex/wx/txrc.tex diff --git a/docs/latex/wx/txrc.tex b/docs/latex/wx/txrc.tex index 1a2cd4d0f9..bcd96e148d 100644 --- a/docs/latex/wx/txrc.tex +++ b/docs/latex/wx/txrc.tex @@ -5,10 +5,6 @@ Classes: \helpref{wxXmlResource}{wxxmlresource}, \helpref{wxXmlResourceHandler}{wxxmlresourcehandler} -{\bf IMPORTANT NOTE:} XRC is not yet a part of the core wxWindows library, so -please see the next section for how to compile and link it. Otherwise if you -try to use it, you will get link errors. - The XML-based resource system, known as XRC, allows user interface elements such as dialogs, menu bars and toolbars, to be stored in text files and loaded into the application at run-time. XRC files can also be compiled into binary XRS files or C++ @@ -26,46 +22,13 @@ is a more elegant solution. \item You can choose between different alternative resource files at run time, if necessary. \item The XRC format uses sizers for flexibility, allowing dialogs to be resizable and highly portable. -\item The XRC format is a wxWindows standard, +\item The XRC format is a wxWidgets standard, and can be generated or postprocessed by any program that understands it. As it is based on the XML standard, existing XML editors can be used for simple editing purposes. \end{itemize} XRC was written by Vaclav Slavik. -\subsection{Compiling and using XRC}\label{compilingxrc} - -XRC can be found under the 'contrib' hierarchy, in the following directories: - -\begin{verbatim} - contrib/src/xrc ; XRC source - contrib/include/wx/xrc ; XRC headers - contrib/samples/xrc ; XRC sample - contrib/utils/wxrc ; XRC resource compiler - contrib/utils/wxrcedit ; XRC editor (in progress) -\end{verbatim} - -To compile XRC: - -\begin{itemize}\itemsep=0pt -\item Under Windows using VC++, open the contrib/src/xrc/XrcVC.dsw project -and compile. Also compile contrib/utils/wxrc using wxBase if you wish to compile -resource files. -\item Under Unix, XRC should be configured when you configured -wxWindows. Make XRC by changing directory to contrib/src/xrc and -type 'make'. Similarly compile contrib/utils/wxrc using wxBase if you wish to compile -resource files. {\bf Note:} there is currently a -problem with the wxWindows build system that means that -only the static version of library can be built at present. -\end{itemize} - -To use XRC: - -\begin{itemize}\itemsep=0pt -\item Under Windows using VC++, link with wxxrc[d].lib. -\item Under Unix, link with libwxxrc[d].a. -\end{itemize} - \subsection{XRC concepts}\label{xrcconcepts} These are the typical steps for using XRC files in your application. @@ -89,14 +52,13 @@ To create an XRC file, you can use one of the following methods. \item use \urlref{wxDesigner}{http://www.roebling.de}, a commercial dialog designer/RAD tool; \item use \urlref{DialogBlocks}{http://www.anthemion.co.uk/dialogblocks}, a commercial dialog editor; \item use \urlref{XRCed}{http://xrced.sf.net}, a wxPython-based -dialog editor that you can find in the {\tt wxPython/tools} subdirectory of the wxWindows +dialog editor that you can find in the {\tt wxPython/tools} subdirectory of the wxWidgets CVS archive; \item use \urlref{Glade}{http://wxglade.sf.net}, a GUI designer written in wxPython. At the moment it can generate Python, C++ and XRC; -\item use wxrcedit ({\tt utils/contrib/wxrcedit}) (under development); \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.wxwindows.org/lnk\_tool.htm}{http://www.wxwindows.org/lnk\_tool.in}. +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.in}. It is highly recommended that you use a resource editing tool, since it's fiddly writing XRC files by hand. @@ -126,14 +88,14 @@ containing class definitions for the windows defined by the XRC file (see specia For example: \begin{verbatim} - % wxrc resource.wrc - % wxrc resource.wrc -o resource.wrs - % wxrc resource.wrc -v -c -o resource.cpp + % wxrc resource.xrc + % wxrc resource.xrc -o resource.xrs + % wxrc resource.xrc -v -c -o resource.cpp \end{verbatim} \wxheading{Note} -XRS file is esentially a renamed ZIP archive which means that you can manipulate +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 \helpref{wxFileSystem}{wxfilesystem} ZIP handler first! It is a simple thing to do: @@ -210,12 +172,12 @@ public: void OnDlg2(wxCommandEvent& event); private: - // any class wishing to process wxWindows events must use this macro + // any class wishing to process wxWidgets events must use this macro DECLARE_EVENT_TABLE() }; // ---------------------------------------------------------------------------- -// event tables and other macros for wxWindows +// event tables and other macros for wxWidgets // ---------------------------------------------------------------------------- BEGIN_EVENT_TABLE(MyFrame, wxFrame) @@ -452,7 +414,7 @@ This is the XML file (resource.xrc) for the XRC sample. \subsection{XRC file format}\label{xrcfileformat} -Please see Technical Note 14 (docs/tech/tn0014.txt) in your wxWindows +Please see Technical Note 14 (docs/tech/tn0014.txt) in your wxWidgets distribution. \subsection{C++ header file generation}\label{xrccppheader} @@ -462,7 +424,7 @@ containing class definitions for the GUI windows defined in the XRC file. This code generation can make it easier to use XRC and automate program development. The classes can be used as basis for development, freeing the -programmer from dealing with most of the XRC specifities (e.g. {\tt XRCCTRL}). +programmer from dealing with most of the XRC specifics (e.g. {\tt XRCCTRL}). For each top level window defined in the XRC file a C++ class definition is generated, containing as class members the named widgets of the window.