on the \urlref{wxWindows Web site}{http://www.wxwindows.org}.
\begin{description}\itemsep=0pt
-\item[Helpview]
+\item[{\bf Helpview}]
Helpview is a program for displaying wxWindows HTML
Help files. In many cases, you may wish to use the wxWindows HTML
Help classes from within your application, but this provides a
handy stand-alone viewer. See \helpref{wxHTML Notes}{wxhtml} for more details.
You can find it in \verb$samples/html/helpview$.
-\item[Tex2RTF]
+\item[{\bf Tex2RTF}]
Supplied with wxWindows is a utility called Tex2RTF for converting\rtfsp
\LaTeX\ manuals HTML, MS HTML Help, wxHTML Help, RTF, and Windows
Help RTF formats. Tex2RTF is used for the wxWindows manuals and can be used independently
\LaTeX\ source. Please see the separate documentation for Tex2RTF.
You can find it under \verb$utils/tex2rtf$.
-\item[Helpgen]
+\item[{\bf Helpgen}]
Helpgen takes C++ header files and generates a Tex2RTF-compatible
documentation file for each class it finds, using comments as appropriate.
This is a good way to start a reference for a set of classes.
-\item[Dialog Editor]
+\item[{\bf Dialog Editor}]
Dialog Editor allows interactive construction of dialogs using
absolute positioning, producing WXR output files. This tool is generally deprecated
in favour of sizer-based tools. You can find Dialog Editor
in \verb$utils/dialoged$.
-\item[XRC resource system]
+\item[{\bf XRC resource system}]
This is the sizer-aware replacement for the WXR resource system, and uses
XML-based resource specifications that can be generated by tools
such as \urlref{wxDesigner}{http://www.roebling.de} and XRC's own wxrcedit.
You can find this in \verb$contrib/src/xrc$, \verb$contrib/include/wx/xrc$, \verb$contrib/samples/xrc$, and \verb$contrib/utils/wxrcedit$.
For more information, see the \helpref{XML-based resource system overview}{xrcoverview}.
-\item[Object Graphics Library]
+\item[{\bf Object Graphics Library}]
OGL defines an API for applications that need to display objects connected by lines.
The objects can be moved around and interacted with.
You can find this in \verb$contrib/src/ogl$, \verb$contrib/include/wx/ogl$, and \verb$contrib/samples/ogl$.
-\item[Frame Layout library]
+\item[{\bf Frame Layout library}]
FL provides sophisticated pane dragging and docking facilities.
You can find this in \verb$contrib/src/fl$, \verb$contrib/include/wx/fl$, and \verb$contrib/samples/fl$.
-\item[Gizmos library]
+\item[{\bf Gizmos library}]
Gizmos is a collection of useful widgets and other classes. Classes include wxLEDNumberCtrl,
wxEditableListBox, wxMultiCellCanvas.
You can find this in \verb$contrib/src/fl$, \verb$contrib/include/wx/fl$, and \verb$contrib/samples/fl$.
-\item[Net library]
+\item[{\bf Net library}]
Net is a collection of very simple mail and web related classes. Currently
there is only wxEmail, which makes it easy to send email messages via MAPI on Windows or sendmail on Unix.
You can find this in \verb$contrib/src/net$ and \verb$contrib/include/wx/net$.
-\item[Animate library]
+\item[{\bf Animate library}]
Animate allows you to load animated GIFs and play them on a window. The library can be extended
to use other animation formats.
You can find this in \verb$contrib/src/animate$, \verb$contrib/include/wx/animate$, and \verb$contrib/samples/animate$.
-\item[Canvas library]
+\item[{\bf Canvas library}]
Canvas supports high-level, double-buffered drawing operations with transformations.
You can find this in \verb$contrib/src/canvas$, \verb$contrib/include/wx/canvas$, and \verb$contrib/samples/canvas$.
-\item[MMedia library]
+\item[{\bf MMedia library}]
Mmedia supports a variety of multimedia functionality. The status of this library is currently unclear.
You can find this in \verb$contrib/src/mmedia$, \verb$contrib/include/wx/mmedia$, and \verb$contrib/samples/mmedia$.
-\item[Styled Text Control library]
+\item[{\bf Styled Text Control library}]
STC is a wrapper around Scintilla, a syntax-highlighting text editor.
You can find this in \verb$contrib/src/stc$, \verb$contrib/include/wx/stc$, and \verb$contrib/samples/stc$.
-\item[Plot]
+\item[{\bf Plot}]
Plot is a simple curve plotting library.
You can find this in \verb$contrib/src/plot$, \verb$contrib/include/wx/plot$, and \verb$contrib/samples/plot$.
\end{description}
\begin{itemize}\itemsep=0
\item Create the file by hand;
-\item use \urlref{wxDesigner}{http://www.roebling.de};
-\item use wxWorkshop (not yet available);
-\item use wxrcedit (the status of this tool is unknown);
-\item convert WIN32 RC files with the tool in contrib/utils/convertrc (the status of this tool is
-unknown).
+\item use \urlref{wxDesigner}{http://www.roebling.de}, a commercial dialog designer/RAD tool;
+\item use \urlref{XRCed}{http://www.mema.ucl.ac.be/~rolinsky/xrced/}, a wxPython-based
+dialog editor that you can find in the {\tt wxPython/tools} subdirectory of the wxWindows
+CVS archive;
+\item use \urlref{wxWorkshop}{http://wxworkshop.sourceforge.net} (under development);
+\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}
It is highly recommended that you use a tool such as wxDesigner, since it's fiddly writing
\subsection{XRC file format}\label{xrcfileformat}
-This section to be written.
+\subsubsection{Introduction to the XRC file format}\label{xrcfileformatintro}
-\subsection{Adding new resource handlers}\label{newresourcehandlers}
+This note describes the file format used for storing XRC resources that are
+used by wxXmlResource class. It is probably only useful for those implementing
+dialog editors with XRC support, or for those writing XRC files by hand.
+
+If you only want to use the resources, you can choose from a number of editors,
+as listed in \helpref{XRC concepts}{xrcconcepts}.
+
+The XRC format is based on XML 1.0 (please consult W3C's specification). There
+is no DTD available since it is not possible to fully describe the format with
+the limited expressive power of DTDs.
+
+\subsubsection{XRC terminology}\label{xrcterminology}
+
+The usual XML terminology applies. In particular, we shall use the terms
+{\it node}, {\it property} and {\it value} in the XML sense:
+
+\begin{verbatim}
+ <node property1="value1" property2="value2">...</node>
+\end{verbatim}
+
+The term "attribute" is specific to XRC and refers to a property-less subnode
+of an <object> or <object_ref> node. In the example bellow, <pos>, <label> and
+<style> are attributes, while neither <resource> nor either of <object>s is:
-This section to be written.
+\begin{verbatim}
+ <?xml version="1.0" encoding="utf-8">
+ <resource version="2.3.0.1">
+ <object class="wxPanel">
+ <style>wxSUNKEN_BORDER</style>
+ <object class="wxStaticText">
+ <label>A label</label>
+ <pos>10,10</pos>
+ </object>
+ </object>
+ </resource>
+\end{verbatim}
+
+\subsubsection{XRC format high-level description}
+
+An XRC resource file is a well-formed XML 1.0 document.
+
+The root node of XRC document must be <resource>. The <resource> node has
+optional {\it version} property. Default version (in absence of the version
+property) is "0.0.0.0". The version consists of four integers separated by
+periods. Version of XRC format changes only if there was an incompatible
+change introduced (i.e. either the library cannot understand old resource
+files or older versions of the library wouldn't understand the new format).
+The first three integers are major, minor and release number of the wxWindows
+release when the change was introduced, the last one is revision number and
+is 0 for the first incompatible change in given wxWindows release, 1 for
+the second, and so on.
+
+Differences between versions are described within this document in paragraphs
+entitled {\it Version Note}.
+
+The <resource> node is only allowed to have <object> and <object_ref>
+subnodes, all of which must have the "name" property.
+
+<object> - TODO (name, class, subclass)
+
+<object_ref> - TODO (name, ref, subclass)
+
+\subsubsection{Common XRC attributes}
+
+Coming soon.
+
+\subsubsection{Supported classes}
+
+Coming soon.
+
+\subsection{Adding new resource handlers}\label{newresourcehandlers}
+Coming soon.
projects / wxWidgets.git / commitdiff
