Removed old classes and functions
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@19902 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -177,17 +177,6 @@ the corresponding topic.
|
||||
\helpref{wxRegisterId}{wxregisterid}\\
|
||||
\helpref{wxRemoveFile}{wxremovefile}\\
|
||||
\helpref{wxRenameFile}{wxrenamefile}\\
|
||||
\helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}\\
|
||||
\helpref{wxResourceClear}{wxresourceclear}\\
|
||||
\helpref{wxResourceCreateBitmap}{wxresourcecreatebitmap}\\
|
||||
\helpref{wxResourceCreateIcon}{wxresourcecreateicon}\\
|
||||
\helpref{wxResourceCreateMenuBar}{wxresourcecreatemenubar}\\
|
||||
\helpref{wxResourceGetIdentifier}{wxresourcegetidentifier}\\
|
||||
\helpref{wxResourceParseData}{wxresourcedata}\\
|
||||
\helpref{wxResourceParseFile}{wxresourceparsefile}\\
|
||||
\helpref{wxResourceParseString}{wxresourceparsestring}\\
|
||||
\helpref{wxResourceRegisterBitmapData}{registerbitmapdata}\\
|
||||
\helpref{wxResourceRegisterIconData}{wxresourceregistericondata}\\
|
||||
\helpref{wxRmdir}{wxrmdir}\\
|
||||
\helpref{wxSafeShowMessage}{wxsafeshowmessage}\\
|
||||
\helpref{wxSafeYield}{wxsafeyield}\\
|
||||
@@ -2519,10 +2508,6 @@ myResource TEXT file.ext
|
||||
|
||||
where {\tt file.ext} is a file that the resource compiler can find.
|
||||
|
||||
One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
|
||||
cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
|
||||
using \helpref{wxResourceParseString}{wxresourceparsestring}.
|
||||
|
||||
This function is available under Windows only.
|
||||
|
||||
\wxheading{Include files}
|
||||
@@ -3000,201 +2985,6 @@ result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
|
||||
\helpref{wxDynamicCast}{wxdynamiccast}\\
|
||||
\helpref{wxConstCast}{wxconstcast}
|
||||
|
||||
\section{Resource functions}\label{resourcefuncs}
|
||||
|
||||
\overview{Resource functions}{resourceformats}
|
||||
|
||||
This section details functions for manipulating wxWindows (.WXR) resource
|
||||
files and loading user interface elements from resources.
|
||||
|
||||
\normalbox{Please note that this use of the word `resource' is different from that used when talking
|
||||
about initialisation file resource reading and writing, using such functions
|
||||
as wxWriteResource and wxGetResource. It is just an unfortunate clash of terminology.}
|
||||
|
||||
\helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
|
||||
|
||||
See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
|
||||
loading from resource data.
|
||||
|
||||
\membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
|
||||
|
||||
\func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
|
||||
|
||||
Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
|
||||
{\tt\#}defining a name to an integer). Unlikely to be used by an application except
|
||||
perhaps for implementing resource functionality for interpreted languages.
|
||||
|
||||
\membersection{::wxResourceClear}\label{wxresourceclear}
|
||||
|
||||
\func{void}{wxResourceClear}{\void}
|
||||
|
||||
Clears the wxWindows resource table.
|
||||
|
||||
\membersection{::wxResourceCreateBitmap}\label{wxresourcecreatebitmap}
|
||||
|
||||
\func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
|
||||
|
||||
Creates a new bitmap from a file, static data, or Windows resource, given a valid
|
||||
wxWindows bitmap resource identifier. For example, if the .WXR file contains
|
||||
the following:
|
||||
|
||||
\begin{verbatim}
|
||||
static const wxString\& project_resource = "bitmap(name = 'project_resource',\
|
||||
bitmap = ['project', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
|
||||
bitmap = ['project.xpm', wxBITMAP_TYPE_XPM, 'X']).";
|
||||
\end{verbatim}
|
||||
|
||||
then this function can be called as follows:
|
||||
|
||||
\begin{verbatim}
|
||||
wxBitmap *bitmap = wxResourceCreateBitmap("project_resource");
|
||||
\end{verbatim}
|
||||
|
||||
\membersection{::wxResourceCreateIcon}\label{wxresourcecreateicon}
|
||||
|
||||
\func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
|
||||
|
||||
Creates a new icon from a file, static data, or Windows resource, given a valid
|
||||
wxWindows icon resource identifier. For example, if the .WXR file contains
|
||||
the following:
|
||||
|
||||
\begin{verbatim}
|
||||
static const wxString\& project_resource = "icon(name = 'project_resource',\
|
||||
icon = ['project', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
|
||||
icon = ['project', wxBITMAP_TYPE_XBM_DATA, 'X']).";
|
||||
\end{verbatim}
|
||||
|
||||
then this function can be called as follows:
|
||||
|
||||
\begin{verbatim}
|
||||
wxIcon *icon = wxResourceCreateIcon("project_resource");
|
||||
\end{verbatim}
|
||||
|
||||
\membersection{::wxResourceCreateMenuBar}\label{wxresourcecreatemenubar}
|
||||
|
||||
\func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
|
||||
|
||||
Creates a new menu bar given a valid wxWindows menubar resource
|
||||
identifier. For example, if the .WXR file contains the following:
|
||||
|
||||
\begin{verbatim}
|
||||
static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
|
||||
menu = \
|
||||
[\
|
||||
['&File', 1, '', \
|
||||
['&Open File', 2, 'Open a file'],\
|
||||
['&Save File', 3, 'Save a file'],\
|
||||
[],\
|
||||
['E&xit', 4, 'Exit program']\
|
||||
],\
|
||||
['&Help', 5, '', \
|
||||
['&About', 6, 'About this program']\
|
||||
]\
|
||||
]).";
|
||||
\end{verbatim}
|
||||
|
||||
then this function can be called as follows:
|
||||
|
||||
\begin{verbatim}
|
||||
wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
\membersection{::wxResourceGetIdentifier}\label{wxresourcegetidentifier}
|
||||
|
||||
\func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
|
||||
|
||||
Used for retrieving the integer value associated with an identifier.
|
||||
A zero value indicates that the identifier was not found.
|
||||
|
||||
See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
|
||||
|
||||
\membersection{::wxResourceParseData}\label{wxresourcedata}
|
||||
|
||||
\func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
|
||||
|
||||
Parses a string containing one or more wxWindows resource objects. If
|
||||
the resource objects are global static data that are included into the
|
||||
C++ program, then this function must be called for each variable
|
||||
containing the resource data, to make it known to wxWindows.
|
||||
|
||||
{\it resource} should contain data in the following form:
|
||||
|
||||
\begin{verbatim}
|
||||
dialog(name = 'dialog1',
|
||||
style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
|
||||
title = 'Test dialog box',
|
||||
x = 312, y = 234, width = 400, height = 300,
|
||||
modal = 0,
|
||||
control = [1000, wxStaticBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
|
||||
[11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
|
||||
control = [1001, wxTextCtrl, '', 'wxTE_MULTILINE', 'text3',
|
||||
156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
|
||||
[11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
|
||||
[11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
|
||||
\end{verbatim}
|
||||
|
||||
This function will typically be used after including a {\tt .wxr} file into
|
||||
a C++ program as follows:
|
||||
|
||||
\begin{verbatim}
|
||||
#include "dialog1.wxr"
|
||||
\end{verbatim}
|
||||
|
||||
Each of the contained resources will declare a new C++ variable, and each
|
||||
of these variables should be passed to wxResourceParseData.
|
||||
|
||||
\membersection{::wxResourceParseFile}\label{wxresourceparsefile}
|
||||
|
||||
\func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
|
||||
|
||||
Parses a file containing one or more wxWindows resource objects
|
||||
in C++-compatible syntax. Use this function to dynamically load
|
||||
wxWindows resource data.
|
||||
|
||||
\membersection{::wxResourceParseString}\label{wxresourceparsestring}
|
||||
|
||||
\func{bool}{wxResourceParseString}{\param{char *}{s}, \param{wxResourceTable *}{table = NULL}}
|
||||
|
||||
Parses a string containing one or more wxWindows resource objects. If
|
||||
the resource objects are global static data that are included into the
|
||||
C++ program, then this function must be called for each variable
|
||||
containing the resource data, to make it known to wxWindows.
|
||||
|
||||
{\it resource} should contain data with the following form:
|
||||
|
||||
\begin{verbatim}
|
||||
dialog(name = 'dialog1',
|
||||
style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
|
||||
title = 'Test dialog box',
|
||||
x = 312, y = 234, width = 400, height = 300,
|
||||
modal = 0,
|
||||
control = [1000, wxStaticBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
|
||||
[11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
|
||||
control = [1001, wxTextCtrl, '', 'wxTE_MULTILINE', 'text3',
|
||||
156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
|
||||
[11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
|
||||
[11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
|
||||
\end{verbatim}
|
||||
|
||||
This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
|
||||
load an entire {\tt .wxr file} into a string.
|
||||
|
||||
\membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
|
||||
|
||||
\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char *}{xbm\_data}, \param{int }{width},
|
||||
\param{int }{height}, \param{wxResourceTable *}{table = NULL}}
|
||||
|
||||
\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char **}{xpm\_data}}
|
||||
|
||||
Makes {\tt\#}included XBM or XPM bitmap data known to the wxWindows resource system.
|
||||
This is required if other resources will use the bitmap data, since otherwise there
|
||||
is no connection between names used in resources, and the global bitmap data.
|
||||
|
||||
\membersection{::wxResourceRegisterIconData}\label{wxresourceregistericondata}
|
||||
|
||||
Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
|
||||
|
||||
\section{Log functions}\label{logfunctions}
|
||||
|
||||
These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
|
||||
|
Reference in New Issue
Block a user