mirror of
https://github.com/wxWidgets/wxWidgets.git
synced 2026-09-26 09:56:32 +08:00
Some doc proofreading
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6718 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -246,7 +246,7 @@ wxWindows' strategy for OnIdle processing is as follows. After pending user inte
|
||||
application have all been processed, wxWindows sends an OnIdle event to the application object. wxApp::OnIdle itself
|
||||
sends an OnIdle event to each application window, allowing windows to do idle processing such as updating
|
||||
their appearance. If either wxApp::OnIdle or a window OnIdle function requested more time, by
|
||||
caling \helpref{wxIdleEvent::ReqestMore}{wxidleeventrequestmore}, wxWindows will send another OnIdle
|
||||
caling \helpref{wxIdleEvent::RequestMore}{wxidleeventrequestmore}, wxWindows will send another OnIdle
|
||||
event to the application object. This will occur in a loop until either a user event is found to be
|
||||
pending, or OnIdle requests no more time. Then all pending user events are processed until the system
|
||||
goes idle again, when OnIdle is called, and so on.
|
||||
@@ -476,7 +476,9 @@ can be overridden by the user to change the default icons.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{which}{One of the wxICON\_XXX defines and chooses which icon to return.}
|
||||
\docparam{which}{One of the wxICON\_XXX specifies which icon to return.}
|
||||
|
||||
See \helpref{wxMessageBox}{wxmessagebox} for a list of icon identifiers.
|
||||
|
||||
\membersection{wxApp::SetUseBestVisual}\label{wxappsetusebestvisual}
|
||||
|
||||
@@ -487,7 +489,7 @@ on systems that support several visual on the same display. This is typically th
|
||||
case under Solaris and IRIX, where the default visual is only 8-bit whereas certain
|
||||
appications are supposed to run in TrueColour mode.
|
||||
|
||||
Note that this function has to be called in the constructor of the {\tt wxApp}
|
||||
Note that this function has to be called in the constructor of the {\tt wxApp}
|
||||
instance and won't have any effect when called later on.
|
||||
|
||||
This function currently only has effect under GTK.
|
||||
|
||||
@@ -261,6 +261,7 @@ WX_DEFINE_SORTED_ARRAY(MyClass *, wxArrayOfMyClass);
|
||||
|
||||
You will have to initialize the objects of this class by passing a comparaison
|
||||
function to the array object constructor like this:
|
||||
|
||||
\begin{verbatim}
|
||||
int CompareInts(int n1, int n2)
|
||||
{
|
||||
|
||||
@@ -175,9 +175,9 @@ Insert("foo", 0);
|
||||
If {\it nIndex} is equal to {\it GetCount() + 1} this function behaves as
|
||||
\helpref{Add}{wxarraystringadd}.
|
||||
|
||||
{\bf Warning:} this function should not be used with sorted array because it
|
||||
{\bf Warning:} this function should not be used with sorted arrays because it
|
||||
could break the order of items and, for example, subsequent calls to
|
||||
\helpref{Index()}{wxarraystringindex} would not work then!
|
||||
\helpref{Index()}{wxarraystringindex} would then not work!
|
||||
|
||||
\membersection{wxArrayString::IsEmpty}\label{wxarraystringisempty}
|
||||
|
||||
@@ -235,12 +235,12 @@ See also: \helpref{Alloc}{wxarraystringalloc}, \helpref{Dynamic array memory man
|
||||
|
||||
\func{void}{Sort}{\param{bool}{ reverseOrder = FALSE}}
|
||||
|
||||
Sorts the array in alphabetical order or in reverse alphabetical order if
|
||||
Sorts the array in alphabetical order or in reverse alphabetical order if
|
||||
{\it reverseOrder} is TRUE.
|
||||
|
||||
{\bf Warning:} this function should not be used with sorted array because it
|
||||
could break the order of items and, for example, subsequent calls to
|
||||
\helpref{Index()}{wxarraystringindex} would not work then!
|
||||
\helpref{Index()}{wxarraystringindex} would then not work!
|
||||
|
||||
See also: \helpref{Sort}{wxarraystringsortcallback}
|
||||
|
||||
@@ -250,7 +250,7 @@ See also: \helpref{Sort}{wxarraystringsortcallback}
|
||||
|
||||
Sorts the array using the specified {\it compareFunction} for item comparison.
|
||||
{\it CompareFunction} is defined as a function taking two {\it const
|
||||
wxString\&} parameters and returning {\it int} value less than, equal to or
|
||||
wxString\&} parameters and returning an {\it int} value less than, equal to or
|
||||
greater than 0 if the first string is less than, equal to or greater than the
|
||||
second one.
|
||||
|
||||
@@ -278,7 +278,7 @@ array.Sort(CompareStringLen);
|
||||
|
||||
{\bf Warning:} this function should not be used with sorted array because it
|
||||
could break the order of items and, for example, subsequent calls to
|
||||
\helpref{Index()}{wxarraystringindex} would not work then!
|
||||
\helpref{Index()}{wxarraystringindex} would then not work!
|
||||
|
||||
See also: \helpref{Sort}{wxarraystringsort}
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
\section{\class{wxBitmapDataObject}}\label{wxbitmapdataobject}
|
||||
|
||||
wxBitmapDataObject is a specialization of wxDataObject for bitmap data. It can
|
||||
be used without change to paste data into the
|
||||
be used without change to paste data into the
|
||||
\helpref{wxClipboard}{wxclipboard} or a \helpref{wxDropSource}{wxdropsource}. A
|
||||
user may wish to derive a new class from this class for providing a bitmap
|
||||
on-demand in order to minimize memory consumption when offering data in several
|
||||
@@ -14,7 +14,7 @@ methods.}
|
||||
|
||||
\wxheading{Virtual functions to override}
|
||||
|
||||
This class may be used as is, but
|
||||
This class may be used as is, but
|
||||
\helpref{GetBitmap}{wxbitmapdataobjectgetbitmap} may be overridden to increase
|
||||
efficiency.
|
||||
|
||||
@@ -29,17 +29,17 @@ efficiency.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{Clipboard and drag and drop overview}{wxdndoverview},
|
||||
\helpref{wxDataObject}{wxdataobject},
|
||||
\helpref{wxDataObjectSimple}{wxdataobjectsimple},
|
||||
\helpref{wxFileDataObject}{wxfiledataobject},
|
||||
\helpref{wxTextDataObject}{wxtextdataobject},
|
||||
\helpref{Clipboard and drag and drop overview}{wxdndoverview},
|
||||
\helpref{wxDataObject}{wxdataobject},
|
||||
\helpref{wxDataObjectSimple}{wxdataobjectsimple},
|
||||
\helpref{wxFileDataObject}{wxfiledataobject},
|
||||
\helpref{wxTextDataObject}{wxtextdataobject},
|
||||
\helpref{wxDataObject}{wxdataobject}
|
||||
|
||||
\func{}{wxBitmapDataObject}{\param{const wxBitmap\& }{bitmap = wxNullBitmap}}
|
||||
|
||||
Constructor, optionally passing a bitmap (otherwise use
|
||||
\helpref{SetBitmap}{wxbitmapdataobjectsetbitmap} later)
|
||||
Constructor, optionally passing a bitmap (otherwise use
|
||||
\helpref{SetBitmap}{wxbitmapdataobjectsetbitmap} later).
|
||||
|
||||
\membersection{wxBitmapDataObject::GetBitmap}\label{wxbitmapdataobjectgetbitmap}
|
||||
|
||||
|
||||
+23
-22
@@ -6,16 +6,15 @@
|
||||
\section{What is wxWindows?}
|
||||
|
||||
wxWindows is a C++ framework providing GUI (Graphical User
|
||||
Interface) and other facilities on more than one platform. Version 2.0 currently
|
||||
supports MS Windows (16-bit, Windows 95 and Windows NT), Unix with GTK+, and Unix with Motif.
|
||||
A Mac port is in an advanced state, an OS/2 port and a port to the MGL graphics library
|
||||
have been started.
|
||||
Interface) and other facilities on more than one platform. Version 2 currently
|
||||
supports MS Windows (16-bit, Windows 95 and Windows NT), Unix with GTK+, Unix with Motif,
|
||||
and Mac. An OS/2 port is in progress.
|
||||
|
||||
wxWindows was originally developed at the Artificial Intelligence
|
||||
Applications Institute, University of Edinburgh, for internal use.
|
||||
wxWindows has been released into the public domain in the hope
|
||||
that others will also find it useful. Version 2.0 is written and
|
||||
maintained by Julian Smart, Robert Roebling, Vadim Zeitlin and others.
|
||||
Applications Institute, University of Edinburgh, for internal use,
|
||||
and was first made publicly available in 1993.
|
||||
Version 2 is a vastly improved version written and maintained by
|
||||
Julian Smart, Robert Roebling, Vadim Zeitlin and many others.
|
||||
|
||||
This manual discusses wxWindows in the context of multi-platform
|
||||
development.\helpignore{For more detail on the wxWindows version 2.0 API
|
||||
@@ -44,9 +43,9 @@ Since wxWindows was started, several other free or almost-free GUI frameworks ha
|
||||
emerged. However, none has the range of features, flexibility, documentation and the
|
||||
well-established development team that wxWindows has.
|
||||
|
||||
As public domain software and a project open to everyone, wxWindows has
|
||||
As open source software, wxWindows has
|
||||
benefited from comments, ideas, bug fixes, enhancements and the sheer
|
||||
enthusiasm of users, especially via the Internet. This gives wxWindows a
|
||||
enthusiasm of users. This gives wxWindows a
|
||||
certain advantage over its commercial competitors (and over free libraries
|
||||
without an independent development team), plus a robustness against
|
||||
the transience of one individual or company. This openness and
|
||||
@@ -54,10 +53,10 @@ availability of source code is especially important when the future of
|
||||
thousands of lines of application code may depend upon the longevity of
|
||||
the underlying class library.
|
||||
|
||||
Version 2.0 goes much further than previous versions in terms of generality and features,
|
||||
Version 2 goes much further than previous versions in terms of generality and features,
|
||||
allowing applications to be produced
|
||||
that are often indistinguishable from those produced using single-platform
|
||||
toolkits such as Motif and MFC.
|
||||
toolkits such as Motif, GTK+ and MFC.
|
||||
|
||||
The importance of using a platform-independent class library cannot be
|
||||
overstated, since GUI application development is very time-consuming,
|
||||
@@ -66,9 +65,9 @@ Code can very quickly become obsolete if it addresses the wrong
|
||||
platform or audience. wxWindows helps to insulate the programmer from
|
||||
these winds of change. Although wxWindows may not be suitable for
|
||||
every application (such as an OLE-intensive program), it provides access to most of the functionality a
|
||||
GUI program normally requires, plus some extras such as network programming
|
||||
and PostScript output, and can of course be extended as needs dictate. As a bonus, it provides
|
||||
a cleaner programming interface than the native
|
||||
GUI program normally requires, plus many extras such as network programming,
|
||||
PostScript output, and HTML rendering; and it can of course be extended as needs dictate. As a bonus, it provides
|
||||
a far cleaner and easier programming interface than the native
|
||||
APIs. Programmers may find it worthwhile to use wxWindows even if they
|
||||
are developing on only one platform.
|
||||
|
||||
@@ -80,8 +79,8 @@ here are some of the benefits:
|
||||
\item You get the source.
|
||||
\item Available on a variety of popular platforms.
|
||||
\item Works with almost all popular C++ compilers and Python.
|
||||
\item Over 40 example programs.
|
||||
\item Over 900 pages of printable and on-line documentation.
|
||||
\item Over 50 example programs.
|
||||
\item Over 1000 pages of printable and on-line documentation.
|
||||
\item Includes Tex2RTF, to allow you to produce your own documentation
|
||||
in Windows Help, HTML and Word RTF formats.
|
||||
\item Simple-to-use, object-oriented API.
|
||||
@@ -97,7 +96,7 @@ in Windows Help, HTML and Word RTF formats.
|
||||
\item Under MS Windows, support for creating metafiles and copying
|
||||
them to the clipboard.
|
||||
\item An API for invoking help from applications.
|
||||
\item Ready to use HTML window (supporting a subset of HTML).
|
||||
\item Ready-to-use HTML window (supporting a subset of HTML).
|
||||
\item Dialog Editor for building dialogs.
|
||||
\item Network support via a family of socket and protocol classes.
|
||||
\item Support for platform independent image procesing.
|
||||
@@ -222,9 +221,11 @@ Metrowerks CodeWarrior.
|
||||
|
||||
\section{Availability and location of wxWindows}
|
||||
|
||||
wxWindows is available by anonymous FTP and World Wide Web
|
||||
\winhelponly{wxWindows is available by anonymous FTP and World Wide Web
|
||||
from ftp://www.remstar.com/pub/wxwin and/or http://www.wxwindows.org.}
|
||||
\winhelpignore{wxWindows is available by anonymous FTP and World Wide Web
|
||||
from \urlref{ftp://www.remstar.com/pub/wxwin}{ftp://www.remstar.com/pub/wxwin}
|
||||
and/or \urlref{http://www.wxwindows.org}{http://www.wxwindows.org}
|
||||
and/or \urlref{http://www.wxwindows.org}{http://www.wxwindows.org}.}
|
||||
|
||||
You can also buy a CD-ROM using the form on the Web site, or by contacting:
|
||||
|
||||
@@ -326,8 +327,8 @@ system it is created on and the version you are using. The library name for the
|
||||
GTK version of wxWindows 2.2 on Linux and Solaris will be libwx\_gtk-2.2.so.0.0.0,
|
||||
on HP-UX, it will be libwx\_gtk-2.2.sl, on AIX just libwx\_gtk.a etc.
|
||||
|
||||
Under Windows, use the library wx.lib for stand-alone Windows
|
||||
applications, or wxdll.lib for creating DLLs.
|
||||
Under Windows, use the library wx.lib (release) or wxd.lib (debug) for stand-alone Windows
|
||||
applications, or wxdll.lib (wxdlld.lib) for creating DLLs.
|
||||
|
||||
\section{Configuration}
|
||||
|
||||
|
||||
@@ -100,21 +100,21 @@ or wxHORIZONTAL for creating either a column sizer or a row sizer.
|
||||
\func{void}{RecalcSizes}{\void}
|
||||
|
||||
Implements the calculation of a box sizer's dimensions and then sets
|
||||
the size of its its children (calling \helpref{wxWindow::SetSize}{wxwindowsetsize}
|
||||
the size of its its children (calling \helpref{wxWindow::SetSize}{wxwindowsetsize}
|
||||
if the child is a window). It is used internally only and must not be called
|
||||
by the users. Documented for information.
|
||||
by the user. Documented for information.
|
||||
|
||||
\membersection{wxBoxSizer::CalcMin}\label{wxboxsizercalcmin}
|
||||
|
||||
\func{wxSize}{CalcMin}{\void}
|
||||
|
||||
Implements the calculation of a box sizer's minimal. It is used internally
|
||||
only and must not be called by the users. Documented for information.
|
||||
only and must not be called by the user. Documented for information.
|
||||
|
||||
\membersection{wxBoxSizer::GetOrientation}\label{wxboxsizergetorientation}
|
||||
|
||||
\func{int}{GetOrientation}{\void}
|
||||
|
||||
Returns the orientation of the boxsizer, either of wxVERTICAL
|
||||
Returns the orientation of the box sizer, either wxVERTICAL
|
||||
or wxHORIZONTAL.
|
||||
|
||||
|
||||
@@ -37,6 +37,7 @@
|
||||
\input conditn.tex
|
||||
\input config.tex
|
||||
\input control.tex
|
||||
\input countstr.tex
|
||||
\input critsect.tex
|
||||
\input crtslock.tex
|
||||
\input custdobj.tex
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
% -----------------------------------------------------------------------------
|
||||
% wxCountingOutputStream
|
||||
% -----------------------------------------------------------------------------
|
||||
\section{\class{wxCountingOutputStream}}\label{wxcountingoutputstream}
|
||||
|
||||
wxCountingOutputStream is a specialized output stream which does not write any data anyway,
|
||||
instead it counts how many bytes would get written if this were a normal stream. This
|
||||
can sometimes be useful or required if some data gets serialized to a stream or compressed
|
||||
by using stream compression and thus the final size of the stream cannot be known other
|
||||
than pretending to write the stream. One case where the resulting size would have to be
|
||||
known is if the data has to be written to a piece of memory and the memory has to be
|
||||
allocated before writing to it (which is probably always the case when writing to a
|
||||
memory stream).
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxOutputStream}{wxoutputstream}
|
||||
\helpref{wxStreamBase}{wxstreambase}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/stream.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
% -----------
|
||||
% ctor & dtor
|
||||
% -----------
|
||||
\membersection{wxCountingOutputStream::wxCountingOutputStream}
|
||||
|
||||
\func{}{wxCountingOutputStream}{\void}
|
||||
|
||||
Creates a wxCountingOutputStream object.
|
||||
|
||||
\membersection{wxCountingOutputStream::\destruct{wxCountingOutputStream}}
|
||||
|
||||
\func{}{\destruct{wxCountingOutputStream}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxCountingOutputStream::GetSize}
|
||||
|
||||
\constfunc{size\_t}{GetSize}{\void}
|
||||
|
||||
Returns the current size of the stream.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
\section{\class{wxCustomDataObject}}\label{wxcustomdataobject}
|
||||
|
||||
wxCustomDataObject is a specialization of
|
||||
wxCustomDataObject is a specialization of
|
||||
\helpref{wxDataObjectSimple}{wxdataobjectsimple} for some
|
||||
application-specific data in arbitrary (either custom or one of the standard
|
||||
ones). The only restriction is that it is supposed that this data can be
|
||||
@@ -8,8 +8,8 @@ copied bitwise (i.e. with {\tt memcpy()}), so it would be a bad idea to make
|
||||
it contain a C++ object (though C struct is fine).
|
||||
|
||||
By default, wxCustomDataObject stores the data inside in a buffer. To put the
|
||||
data into the buffer you may use either
|
||||
\helpref{SetData}{wxcustomdataobjectsetdata} or
|
||||
data into the buffer you may use either
|
||||
\helpref{SetData}{wxcustomdataobjectsetdata} or
|
||||
\helpref{TakeData}{wxcustomdataobjecttakedata} depending on whether you want
|
||||
the object to make a copy of data or not.
|
||||
|
||||
@@ -20,9 +20,9 @@ the virtual functions mentioned below.
|
||||
\wxheading{Virtual functions to override}
|
||||
|
||||
This class may be used as is, but if you don't want store the data inside the
|
||||
object but provide it on demand instead, you should override
|
||||
\helpref{GetSize}{wxcustomdataobjectgetsize},
|
||||
\helpref{GetData}{wxcustomdataobjectgetdata} and
|
||||
object but provide it on demand instead, you should override
|
||||
\helpref{GetSize}{wxcustomdataobjectgetsize},
|
||||
\helpref{GetData}{wxcustomdataobjectgetdata} and
|
||||
\helpref{SetData}{wxcustomdataobjectsetdata} (or may be only the first two or
|
||||
only the last one if you only allow reading/writing the data)
|
||||
|
||||
@@ -46,7 +46,7 @@ only the last one if you only allow reading/writing the data)
|
||||
\func{}{wxCustomDataObject}{\param{const wxDataFormat\& }{format = wxFormatInvalid}}
|
||||
|
||||
The constructor accepts a {\it format} argument which specifies the (single)
|
||||
format supported by this object. If it isn't set here,
|
||||
format supported by this object. If it isn't set here,
|
||||
\helpref{SetFormat}{wxdataobjectsimplesetformat} should be used.
|
||||
|
||||
\membersection{wxCustomDataObject::\destruct{wxCustomDataObject}}\label{wxcustomdataobjectdtor}
|
||||
|
||||
@@ -3,6 +3,9 @@
|
||||
Every database object represents an ODBC connection.
|
||||
The connection may be closed and reopened.
|
||||
|
||||
Note: this class is considered obsolete, replaced by the Remstar wxDB/wxTable classes
|
||||
(documented separately in Word and PDF format, as odbc.doc and odbc.pdf).
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
@@ -48,7 +48,7 @@ do clipboard format registration at this time will usually lead to a crash!
|
||||
|
||||
\wxheading{Virtual functions to override}
|
||||
|
||||
None, this class doesn't have any.
|
||||
None
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
|
||||
+23
-23
@@ -33,7 +33,7 @@ enum Direction
|
||||
};
|
||||
\end{verbatim}
|
||||
|
||||
which allows to distinguish between them. See
|
||||
which allows to distinguish between them. See
|
||||
\helpref{wxDataFormat}{wxdataformat} documentation for more about formats.
|
||||
|
||||
Not surprizingly, being 'smart' comes at a price of added complexity. This is
|
||||
@@ -42,8 +42,8 @@ but may be annoying if you only want to do something simple like cut and paste
|
||||
text.
|
||||
|
||||
To provide a solution for both cases, wxWindows has two predefined classes
|
||||
which derive from wxDataObject: \helpref{wxDataObjectSimple}{wxdataobjectsimple} and
|
||||
\helpref{wxDataObjectComposite}{wxdataobjectcomposite}.
|
||||
which derive from wxDataObject: \helpref{wxDataObjectSimple}{wxdataobjectsimple} and
|
||||
\helpref{wxDataObjectComposite}{wxdataobjectcomposite}.
|
||||
\helpref{wxDataObjectSimple}{wxdataobjectsimple} is
|
||||
the simplest wxDataObject possible and only holds data in a single format (such
|
||||
as HTML or text) and \helpref{wxDataObjectComposite}{wxdataobjectcomposite} is
|
||||
@@ -54,18 +54,18 @@ So, you have several solutions when you need a wxDataObject class (and you need
|
||||
one as soon as you want to transfer data via the clipboard or drag and drop):
|
||||
|
||||
\begin{twocollist}\itemsep=1cm
|
||||
\twocolitem{{\bf 0. Use one of built-in classes}}{You may use wxTextDataObject,
|
||||
\twocolitem{{\bf 1. Use one of the built-in classes}}{You may use wxTextDataObject,
|
||||
wxBitmapDataObject or wxFileDataObject in the simplest cases when you only need
|
||||
to support one format and your data is either text, bitmap or list of files.}
|
||||
\twocolitem{{\bf 1. Use wxDataObjectSimple}}{Deriving from wxDataObjectSimple is the simplest
|
||||
\twocolitem{{\bf 2. Use wxDataObjectSimple}}{Deriving from wxDataObjectSimple is the simplest
|
||||
solution for custom data - you will only support one format and so probably
|
||||
won't be able to communicate with other programs, but data transfer will work
|
||||
in your program (or between different copies of it).}
|
||||
\twocolitem{{\bf 2. Use wxDataObjectComposite}}{This is a simple but powerful
|
||||
\twocolitem{{\bf 3. Use wxDataObjectComposite}}{This is a simple but powerful
|
||||
solution which allows you to support any number of formats (either
|
||||
standard or custom if you combine it with the previous solution).}
|
||||
\twocolitem{{\bf 3. Use wxDataObject directly}}{This is the solution for
|
||||
maximal flexibility and efficiency, but it also is the most difficult to
|
||||
\twocolitem{{\bf 4. Use wxDataObject directly}}{This is the solution for
|
||||
maximal flexibility and efficiency, but it is also is the most difficult to
|
||||
implement.}
|
||||
\end{twocollist}
|
||||
|
||||
@@ -86,12 +86,12 @@ clipboard after having pressed 'Copy' - in reality it is only declared to be
|
||||
available.
|
||||
|
||||
There are several predefined data object classes derived from
|
||||
wxDataObjectSimple: \helpref{wxFileDataObject}{wxfiledataobject},
|
||||
\helpref{wxTextDataObject}{wxtextdataobject} and
|
||||
wxDataObjectSimple: \helpref{wxFileDataObject}{wxfiledataobject},
|
||||
\helpref{wxTextDataObject}{wxtextdataobject} and
|
||||
\helpref{wxBitmapDataObject}{wxbitmapdataobject} which can be used without
|
||||
change.
|
||||
|
||||
You may also derive your own data object classes from
|
||||
You may also derive your own data object classes from
|
||||
\helpref{wxCustomDataObject}{wxcustomdataobject} for user-defined types. The
|
||||
format of user-defined data is given as mime-type string literal, such as
|
||||
"application/word" or "image/png". These strings are used as they are under
|
||||
@@ -101,7 +101,7 @@ and from the clipboard and for drag and drop). Note that the format string
|
||||
translation under Windows is not yet finished.
|
||||
|
||||
\pythonnote{At this time this class is not directly usable from wxPython.
|
||||
Derive a class from \helpref{wxPyDataObjectSimple}{wxdataobjectsimple}
|
||||
Derive a class from \helpref{wxPyDataObjectSimple}{wxdataobjectsimple}
|
||||
instead.}
|
||||
|
||||
\wxheading{Virtual functions to override}
|
||||
@@ -110,7 +110,7 @@ Each class derived directly from wxDataObject must override and implement all
|
||||
of its functions which are pure virtual in the base class.
|
||||
|
||||
The data objects which only render their data or only set it (i.e. work in
|
||||
only one direction), should return 0 from
|
||||
only one direction), should return 0 from
|
||||
\helpref{GetFormatCount}{wxdataobjectgetformatcount}.
|
||||
|
||||
\wxheading{Derived from}
|
||||
@@ -123,15 +123,15 @@ None
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{Clipboard and drag and drop overview}{wxdndoverview},
|
||||
\helpref{DnD sample}{samplednd},
|
||||
\helpref{wxFileDataObject}{wxfiledataobject},
|
||||
\helpref{wxTextDataObject}{wxtextdataobject},
|
||||
\helpref{wxBitmapDataObject}{wxbitmapdataobject},
|
||||
\helpref{wxCustomDataObject}{wxcustomdataobject},
|
||||
\helpref{wxDropTarget}{wxdroptarget},
|
||||
\helpref{wxDropSource}{wxdropsource},
|
||||
\helpref{wxTextDropTarget}{wxtextdroptarget},
|
||||
\helpref{Clipboard and drag and drop overview}{wxdndoverview},
|
||||
\helpref{DnD sample}{samplednd},
|
||||
\helpref{wxFileDataObject}{wxfiledataobject},
|
||||
\helpref{wxTextDataObject}{wxtextdataobject},
|
||||
\helpref{wxBitmapDataObject}{wxbitmapdataobject},
|
||||
\helpref{wxCustomDataObject}{wxcustomdataobject},
|
||||
\helpref{wxDropTarget}{wxdroptarget},
|
||||
\helpref{wxDropSource}{wxdropsource},
|
||||
\helpref{wxTextDropTarget}{wxtextdroptarget},
|
||||
\helpref{wxFileDropTarget}{wxfiledroptarget}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -152,7 +152,7 @@ Destructor.
|
||||
|
||||
\constfunc{virtual void}{GetAllFormats}{ \param{wxDataFormat *}{formats}, \param{Direction}{ dir = Get}}
|
||||
|
||||
Copy all supported formats in the given direction to the array pointed to by
|
||||
Copy all supported formats in the given direction to the array pointed to by
|
||||
{\it formats}. There is enough space for GetFormatCount(dir) formats in it.
|
||||
|
||||
\membersection{wxDataObject::GetDataHere}\label{wxdataobjectgetdatahere}
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
A class for manipulating dates.
|
||||
|
||||
{\bf NOTE:} this class should be
|
||||
used with caution, since it is not fully tested. It will be replaced
|
||||
with a new wxDateTime class in the near future.
|
||||
{\bf NOTE:} this class is retained only for compatibility,
|
||||
and has been replaced by \helpref{wxDateTime}{wxdatetime}. wxDate
|
||||
may be withdrawn in future versions of wxWindows.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
|
||||
@@ -26,8 +26,7 @@ wxDateTime object.
|
||||
All the following constants are defined inside wxDateTime class (i.e., to refer to
|
||||
them you should prepend their names with {\tt wxDateTime::}).
|
||||
|
||||
Time zone symbolic names:%\label{wxdatetimetimezones} % Sorry, labels not allowed here.
|
||||
|
||||
Time zone symbolic names:
|
||||
|
||||
\begin{verbatim}
|
||||
enum TZ
|
||||
@@ -116,7 +115,7 @@ wxDateSpan,\rtfsp
|
||||
|
||||
\membersection{Static functions}
|
||||
|
||||
For convinience, all static functions are collected here. These functions
|
||||
For convenience, all static functions are collected here. These functions
|
||||
either set or return the static variables of wxDateSpan (the country), return
|
||||
the current moment, year, month or number of days in it, or do some general
|
||||
calendar-related actions.
|
||||
|
||||
@@ -17,6 +17,7 @@ is defined as signed int on 32-bit architectures) so that you cannot use long. T
|
||||
problems (here and elsewhere), make use of the wxInt32, wxUint32, etc types.
|
||||
|
||||
For example:
|
||||
|
||||
\begin{verbatim}
|
||||
wxFileInputStream input( "mytext.dat" );
|
||||
wxDataInputStream store( input );
|
||||
|
||||
@@ -176,7 +176,7 @@ a transparency mask, the bitmap will be drawn transparently.
|
||||
|
||||
When drawing a mono-bitmap, the current text foreground colour will be used to draw the foreground
|
||||
of the bitmap (all bits set to 1), and the current text background colour to draw the background
|
||||
(all bits set to 0). See also \helpref{SetTextForeground}{wxdcsettextforeground},
|
||||
(all bits set to 0). See also \helpref{SetTextForeground}{wxdcsettextforeground},
|
||||
\helpref{SetTextBackground}{wxdcsettextbackground} and \helpref{wxMemoryDC}{wxmemorydc}.
|
||||
|
||||
\membersection{wxDC::DrawCheckMark}\label{wxdcdrawcheckmark}
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
|
||||
\section{\class{wxDataObjectSimple}}\label{wxdataobjectsimple}
|
||||
|
||||
This is the simplest possible implementation of
|
||||
This is the simplest possible implementation of the
|
||||
\helpref{wxDataObject}{wxdataobject} class. The data object of (a class derived
|
||||
from) this class only supports one format, so the number of virtual functions
|
||||
to be implemented is reduced.
|
||||
@@ -26,8 +26,8 @@ methods.}
|
||||
|
||||
\wxheading{Virtual functions to override}
|
||||
|
||||
The objects supporting rendering the data must override
|
||||
\helpref{GetDataSize}{wxdataobjectsimplegetdatasize} and
|
||||
The objects supporting rendering the data must override
|
||||
\helpref{GetDataSize}{wxdataobjectsimplegetdatasize} and
|
||||
\helpref{GetDataHere}{wxdataobjectsimplegetdatahere} while the objects which
|
||||
may be set must override \helpref{SetData}{wxdataobjectsimplesetdata}. Of
|
||||
course, the objects supporting both operations must override all threee
|
||||
@@ -43,10 +43,10 @@ methods.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{Clipboard and drag and drop overview}{wxdndoverview},
|
||||
\helpref{DnD sample}{samplednd},
|
||||
\helpref{wxFileDataObject}{wxfiledataobject},
|
||||
\helpref{wxTextDataObject}{wxtextdataobject},
|
||||
\helpref{Clipboard and drag and drop overview}{wxdndoverview},
|
||||
\helpref{DnD sample}{samplednd},
|
||||
\helpref{wxFileDataObject}{wxfiledataobject},
|
||||
\helpref{wxTextDataObject}{wxtextdataobject},
|
||||
\helpref{wxBitmapDataObject}{wxbitmapdataobject}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -99,4 +99,3 @@ the derived class if the object supports setting its data.
|
||||
\pythonnote{When implementing this method in wxPython, the data comes
|
||||
as a single string parameter rather than the two shown here.}
|
||||
|
||||
|
||||
|
||||
@@ -191,10 +191,15 @@ See also \helpref{Modify}{wxdocumentmodify}.
|
||||
|
||||
\func{virtual istream\&}{LoadObject}{\param{istream\& }{stream}}
|
||||
|
||||
\func{virtual wxInputStream\&}{LoadObject}{\param{wxInputStream\& }{stream}}
|
||||
|
||||
Override this function and call it from your own LoadObject before
|
||||
streaming your own data. LoadObject is called by the framework
|
||||
automatically when the document contents need to be loaded.
|
||||
|
||||
Note that only one of these forms exists, depending on how wxWindows
|
||||
was configured.
|
||||
|
||||
\membersection{wxDocument::Modify}\label{wxdocumentmodify}
|
||||
|
||||
\func{virtual void}{Modify}{\param{bool}{ modify}}
|
||||
@@ -297,10 +302,15 @@ Prompts the user for a file to save to, and then calls OnSaveDocument.
|
||||
|
||||
\func{virtual ostream\&}{SaveObject}{\param{ostream\& }{stream}}
|
||||
|
||||
\func{virtual wxOutputStream\&}{SaveObject}{\param{wxOutputStream\& }{stream}}
|
||||
|
||||
Override this function and call it from your own SaveObject before
|
||||
streaming your own data. SaveObject is called by the framework
|
||||
automatically when the document contents need to be saved.
|
||||
|
||||
Note that only one of these forms exists, depending on how wxWindows
|
||||
was configured.
|
||||
|
||||
\membersection{wxDocument::SetCommandProcessor}
|
||||
|
||||
\func{virtual void}{SetCommandProcessor}{\param{wxCommandProcessor *}{processor}}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
This class represents a source for a drag and drop operation.
|
||||
|
||||
See \helpref{Drag'n'Drop overview}{wxdndoverview} and \helpref{wxDataObject overview}{wxdataobjectoverview}
|
||||
See \helpref{Drag'n'Drop overview}{wxdndoverview} and \helpref{wxDataObject overview}{wxdataobjectoverview}
|
||||
for more information.
|
||||
|
||||
\wxheading{Derived from}
|
||||
@@ -17,7 +17,7 @@ None
|
||||
|
||||
\index{wxDragResult}wxDragResult is defined as follows:
|
||||
|
||||
{\small\begin{verbatim}
|
||||
begin{verbatim}
|
||||
enum wxDragResult
|
||||
{
|
||||
wxDragError, // error prevented the d&d operation from completing
|
||||
@@ -27,7 +27,6 @@ enum wxDragResult
|
||||
wxDragCancel // the operation was cancelled by user (not an error)
|
||||
};
|
||||
\end{verbatim}
|
||||
}
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ None
|
||||
|
||||
\index{wxDragResult}wxDragResult is defined as follows:
|
||||
|
||||
{\small\begin{verbatim}
|
||||
\begin{verbatim}
|
||||
enum wxDragResult
|
||||
{
|
||||
wxDragError, // error prevented the d&d operation from completing
|
||||
@@ -36,7 +36,6 @@ enum wxDragResult
|
||||
wxDragCancel // the operation was cancelled by user (not an error)
|
||||
};
|
||||
\end{verbatim}
|
||||
}
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ each other.
|
||||
\func{virtual void}{AddPendingEvent}{\param{wxEvent\& }{event}}
|
||||
|
||||
Adds an event to be processed later. The function will return immediately and the
|
||||
event will get processed in idle time using the \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}
|
||||
event will get processed in idle time using the \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}
|
||||
method.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
@@ -46,8 +46,8 @@ Construct a floating point expression.
|
||||
Construct a list expression. The list's nodes' data should
|
||||
themselves be {\bf wxExpr}s.
|
||||
|
||||
The current version of this library no longer uses the {\bf wxList}
|
||||
internally, so this constructor turns the list into its internal
|
||||
wxExpr no longer uses the {\bf wxList} internally,
|
||||
so this constructor turns the list into its internal
|
||||
format (assuming a non-nested list) and then deletes the supplied
|
||||
list.
|
||||
|
||||
@@ -376,7 +376,6 @@ bool myErrorHandler(int err, chat *msg)
|
||||
wxExprDatabase database(myErrorHandler);
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
\func{}{wxExprDatabase}{\param{wxExprType}{ type}, \param{const wxString\&}{attribute},
|
||||
\rtfsp\param{int}{ size = 500}, \param{proioErrorHandler}{ handler = 0}}
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
\section{\class{wxFileDataObject}}\label{wxfiledataobject}
|
||||
|
||||
wxFileDataObject is a specialization of \helpref{wxDataObject}{wxdataobject}
|
||||
for file names. The program works with it just as if it were a list of file
|
||||
names (absolutep aths always), but internally it uses the same format as
|
||||
for file names. The program works with it just as if it were a list of absolute file
|
||||
names, but internally it uses the same format as
|
||||
Explorer and other compatible programs under Windows or GNOME/KDE filemanager
|
||||
under Unix which makes it possible to receive files from them using this
|
||||
class.
|
||||
@@ -30,7 +30,7 @@ None.
|
||||
\helpref{wxDataObject}{wxdataobject},
|
||||
\helpref{wxDataObjectSimple}{wxdataobjectsimple},
|
||||
\helpref{wxTextDataObject}{wxtextdataobject},
|
||||
\helpref{wxBitmapDataObject}{wxbitmapdataobject}
|
||||
\helpref{wxBitmapDataObject}{wxbitmapdataobject},
|
||||
\helpref{wxDataObject}{wxdataobject}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
@@ -18,7 +18,6 @@ None.
|
||||
|
||||
wx/file.h defines the following constants:
|
||||
|
||||
{\small
|
||||
\begin{verbatim}
|
||||
#define wxS_IRUSR 00400
|
||||
#define wxS_IWUSR 00200
|
||||
@@ -35,7 +34,6 @@ wx/file.h defines the following constants:
|
||||
// default mode for the new files: corresponds to umask 022
|
||||
#define wxS_DEFAULT (wxS_IRUSR | wxS_IWUSR | wxS_IRGRP | wxS_IWGRP | wxS_IROTH | wxS_IWOTH)
|
||||
\end{verbatim}
|
||||
}
|
||||
|
||||
These constants define the file access rights and are used with
|
||||
\helpref{wxFile::Create}{wxfilecreate} and \helpref{wxFile::Open}{wxfileopen}.
|
||||
|
||||
@@ -21,6 +21,8 @@ from another stream and pass it to the requester.
|
||||
The interface of this class is the same as that of wxInputStream. Only a constructor
|
||||
differs and it is documented below.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
% -----------
|
||||
% ctor & dtor
|
||||
% -----------
|
||||
|
||||
@@ -22,6 +22,8 @@ stream.
|
||||
The use of this class is exactly the same as of wxOutputStream. Only a constructor
|
||||
differs and it is documented below.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
% -----------
|
||||
% ctor & dtor
|
||||
% -----------
|
||||
|
||||
@@ -19,10 +19,9 @@ the given \helpref{encoding}{wxfontencodingoverview}.
|
||||
To do this, you just have to call one of EnumerateXXX() functions - either
|
||||
\helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames} or
|
||||
\helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings} and the
|
||||
corresponding callback (
|
||||
\helpref{OnFacename}{wxFontEnumeratoronfacename} or
|
||||
corresponding callback (\helpref{OnFacename}{wxFontEnumeratoronfacename} or
|
||||
\helpref{OnFontEncoding}{wxfontenumeratoronfontencoding}) will be called
|
||||
repeatedly until either all fonts (satisfying the specified criteria) are
|
||||
repeatedly until either all fonts satisfying the specified criteria are
|
||||
exhausted or the callback returns FALSE.
|
||||
|
||||
\wxheading{Virtual functions to override}
|
||||
|
||||
@@ -20,7 +20,7 @@ never TRUE, the config file is never created anyhow.
|
||||
|
||||
In case everything else fails (i.e. there is no record in config file
|
||||
and "interactive" is FALSE or user denied to choose any replacement),
|
||||
the class queries \helpref{wxEncodingConverter}{wxencodingconverter}
|
||||
the class queries \helpref{wxEncodingConverter}{wxencodingconverter}
|
||||
for "equivalent" encodings (e.g. iso8859-2 and cp1250) and tries them.
|
||||
|
||||
\wxheading{Global variables}
|
||||
@@ -72,7 +72,6 @@ No base class
|
||||
\helpref{wxEncodingConverter}{wxencodingconverter},
|
||||
\helpref{Writing non-English applications}{nonenglishoverview}
|
||||
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxFontMapper::wxFontMapper}\label{wxfontmapperwxfontmapper}
|
||||
@@ -81,14 +80,12 @@ No base class
|
||||
|
||||
Default ctor.
|
||||
|
||||
|
||||
\membersection{wxFontMapper::\destruct{wxFontMapper}}\label{wxfontmapperdtor}
|
||||
|
||||
\func{}{\destruct{wxFontMapper}}{\void}
|
||||
|
||||
Virtual dtor for a base class.
|
||||
|
||||
|
||||
\membersection{wxFontMapper::GetAltForEncoding}\label{wxfontmappergetaltforencoding}
|
||||
|
||||
\func{bool}{GetAltForEncoding}{\param{wxFontEncoding }{encoding}, \param{wxNativeEncodingInfo* }{info}, \param{const wxString\& }{facename = wxEmptyString}, \param{bool }{interactive = TRUE}}
|
||||
@@ -104,7 +101,6 @@ The first form is for wxWindows' internal use while the second one
|
||||
is better suitable for general use -- it returns wxFontEncoding which
|
||||
can consequently be passed to wxFont constructor.
|
||||
|
||||
|
||||
\membersection{wxFontMapper::IsEncodingAvailable}\label{wxfontmapperisencodingavailable}
|
||||
|
||||
\func{bool}{IsEncodingAvailable}{\param{wxFontEncoding }{encoding}, \param{const wxString\& }{facename = wxEmptyString}}
|
||||
@@ -112,7 +108,6 @@ can consequently be passed to wxFont constructor.
|
||||
Check whether given encoding is available in given face or not.
|
||||
If no facename is given, find {\it any} font in this encoding.
|
||||
|
||||
|
||||
\membersection{wxFontMapper::CharsetToEncoding}\label{wxfontmappercharsettoencoding}
|
||||
|
||||
\func{wxFontEncoding}{CharsetToEncoding}{\param{const wxString\& }{charset}, \param{bool }{interactive = TRUE}}
|
||||
@@ -120,36 +115,31 @@ If no facename is given, find {\it any} font in this encoding.
|
||||
Returns the encoding for the given charset (in the form of RFC 2046) or
|
||||
wxFONTENCODING\_SYSTEM if couldn't decode it.
|
||||
|
||||
|
||||
\membersection{wxFontMapper::GetEncodingName}\label{wxfontmappergetencodingname}
|
||||
|
||||
\func{static wxString}{GetEncodingName}{\param{wxFontEncoding }{encoding}}
|
||||
|
||||
Return internal string identifier for the encoding (see also
|
||||
Return internal string identifier for the encoding (see also
|
||||
\helpref{GetEncodingDescription()}{wxfontmappergetencodingdescription})
|
||||
|
||||
|
||||
\membersection{wxFontMapper::GetEncodingDescription}\label{wxfontmappergetencodingdescription}
|
||||
|
||||
\func{static wxString}{GetEncodingDescription}{\param{wxFontEncoding }{encoding}}
|
||||
|
||||
Return user-readable string describing the given encoding.
|
||||
|
||||
|
||||
\membersection{wxFontMapper::SetDialogParent}\label{wxfontmappersetdialogparent}
|
||||
|
||||
\func{void}{SetDialogParent}{\param{wxWindow* }{parent}}
|
||||
|
||||
The parent window for modal dialogs.
|
||||
|
||||
|
||||
\membersection{wxFontMapper::SetDialogTitle}\label{wxfontmappersetdialogtitle}
|
||||
|
||||
\func{void}{SetDialogTitle}{\param{const wxString\& }{title}}
|
||||
|
||||
The title for the dialogs (note that default is quite reasonable).
|
||||
|
||||
|
||||
\membersection{wxFontMapper::SetConfig}\label{wxfontmappersetconfig}
|
||||
|
||||
\func{void}{SetConfig}{\param{wxConfigBase* }{config}}
|
||||
|
||||
@@ -235,7 +235,7 @@ Returns a pointer to the menubar currently associated with the frame (if any).
|
||||
|
||||
\membersection{wxFrame::GetStatusBar}\label{wxframegetstatusbar}
|
||||
|
||||
\func{wxStatusBar*}{GetStatusBar}{\void}
|
||||
\constfunc{wxStatusBar*}{GetStatusBar}{\void}
|
||||
|
||||
Returns a pointer to the status bar currently associated with the frame (if any).
|
||||
|
||||
@@ -245,14 +245,13 @@ Returns a pointer to the status bar currently associated with the frame (if any)
|
||||
|
||||
\membersection{wxFrame::GetTitle}\label{wxframegettitle}
|
||||
|
||||
\func{wxString\&}{GetTitle}{\void}
|
||||
\constfunc{wxString}{GetTitle}{\void}
|
||||
|
||||
Gets a temporary pointer to the frame title. See
|
||||
\helpref{wxFrame::SetTitle}{wxframesettitle}.
|
||||
Gets a string containing the frame title. See \helpref{wxFrame::SetTitle}{wxframesettitle}.
|
||||
|
||||
\membersection{wxFrame::GetToolBar}\label{wxframegettoolbar}
|
||||
|
||||
\func{wxToolBar*}{GetToolBar}{\void}
|
||||
\constfunc{wxToolBar*}{GetToolBar}{\void}
|
||||
|
||||
Returns a pointer to the toolbar currently associated with the frame (if any).
|
||||
|
||||
@@ -263,7 +262,7 @@ Returns a pointer to the toolbar currently associated with the frame (if any).
|
||||
|
||||
\membersection{wxFrame::Iconize}\label{wxframeiconize}
|
||||
|
||||
\func{void}{Iconize}{\param{const bool}{ iconize}}
|
||||
\func{void}{Iconize}{\param{bool}{ iconize}}
|
||||
|
||||
Iconizes or restores the frame. Windows only.
|
||||
|
||||
@@ -289,13 +288,13 @@ Returns TRUE if the frame is maximized.
|
||||
|
||||
\membersection{wxFrame::Maximize}\label{wxframemaximize}
|
||||
|
||||
\func{void}{Maximize}{\param{const bool }{maximize}}
|
||||
\func{void}{Maximize}{\param{bool }{maximize}}
|
||||
|
||||
Maximizes or restores the frame.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{maximize}{If TRUE, maximizes the frame, otherwise it restores it}.
|
||||
\docparam{maximize}{If TRUE, maximizes the frame, otherwise it restores it.}
|
||||
|
||||
\wxheading{Remarks}
|
||||
|
||||
|
||||
+16
-16
@@ -10,7 +10,7 @@ It provides more information than wxWindow's input stream
|
||||
(stream, filename, mime type, anchor).
|
||||
|
||||
{\bf Note:} Any pointer returned by wxFSFile's member is valid
|
||||
only as long as wxFSFile object exits. For example call to GetStream()
|
||||
only as long as wxFSFile object exists. For example a call to GetStream()
|
||||
doesn't {\it create} the stream but only returns the pointer to it. In
|
||||
other words after 10 calls to GetStream() you'll obtain ten identical
|
||||
pointers.
|
||||
@@ -26,7 +26,7 @@ pointers.
|
||||
\wxheading{See Also}
|
||||
|
||||
\helpref{wxFileSystemHandler}{wxfilesystemhandler},
|
||||
\helpref{wxFileSystem}{wxfilesystem},
|
||||
\helpref{wxFileSystem}{wxfilesystem},
|
||||
\helpref{Overview}{fs}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -47,17 +47,17 @@ Constructor. You probably won't use it. See Notes for details.
|
||||
|
||||
\docparam{anchor}{Anchor. See \helpref{GetAnchor()}{wxfsfilegetanchor} for details.}
|
||||
|
||||
If you aren't sure what do these params mean see description of GetXXXX()
|
||||
If you are not sure of the meaning of these params, see the description of the GetXXXX()
|
||||
functions.
|
||||
|
||||
\wxheading{Notes}
|
||||
|
||||
It is never used by end user but you'll need it if
|
||||
you're writing own virtual FS. For example you may need something
|
||||
similar to wxMemoryInputStream but because wxMemoryInputStream
|
||||
doesn't free the memory when destroyed and thus passing memory stream
|
||||
It is seldom used by the application programmer but you'll need it if
|
||||
you are writing your own virtual FS. For example you may need something
|
||||
similar to wxMemoryInputStream, but because wxMemoryInputStream
|
||||
doesn't free the memory when destroyed and thus passing a memory stream
|
||||
pointer into wxFSFile constructor would lead to memory leaks, you
|
||||
can write your own class derived from wxFSFile :
|
||||
can write your own class derived from wxFSFile:
|
||||
|
||||
\begin{verbatim}
|
||||
class wxMyFSFile : public wxFSFile
|
||||
@@ -85,10 +85,10 @@ archive/main.zip#zip:index.htm#global /* 'global' */
|
||||
archive/main.zip#zip:index.htm /* NO anchor here! */
|
||||
\end{verbatim}
|
||||
|
||||
Usually anchor is presented only if mime type is 'text/html'.
|
||||
But it may have some meaning with other files
|
||||
(for example myanim.avi\#200 may refer to position in animation
|
||||
or reality.wrl\#MyView may refer to predefined view in VRML)
|
||||
Usually an anchor is presented only if the MIME type is 'text/html'.
|
||||
But it may have some meaning with other files;
|
||||
for example myanim.avi\#200 may refer to position in animation
|
||||
or reality.wrl\#MyView may refer to a predefined view in VRML.
|
||||
|
||||
\membersection{wxFSFile::GetLocation}\label{wxfsfilegetlocation}
|
||||
|
||||
@@ -108,7 +108,7 @@ relative-file.htm
|
||||
|
||||
\constfunc{const wxString\&}{GetMimeType}{\void}
|
||||
|
||||
Returns MIME type of the content of this file. It is either
|
||||
Returns the MIME type of the content of this file. It is either
|
||||
extension-based (see wxMimeTypesManager) or extracted from
|
||||
HTTP protocol Content-Type header.
|
||||
|
||||
@@ -125,7 +125,7 @@ Returns time when this file was modified.
|
||||
Returns pointer to the stream. You can use the returned
|
||||
stream to directly access data. You may suppose
|
||||
that the stream provide Seek and GetSize functionality
|
||||
(even in case of HTTP protocol which doesn't provide
|
||||
this by default. wxHtml is using local cache to workaround
|
||||
this and to speed up connection)
|
||||
(even in the case of the HTTP protocol which doesn't provide
|
||||
this by default. wxHtml uses local cache to work around
|
||||
this and to speed up the connection).
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ the expected result.
|
||||
|
||||
\wxheading{Return value}
|
||||
|
||||
TRUE, if the command has been sent successfully, else FALSE.
|
||||
TRUE if the command has been sent successfully, else FALSE.
|
||||
|
||||
% ----------------------------------------------------------------------------
|
||||
|
||||
@@ -172,10 +172,10 @@ An initialized write-only stream.
|
||||
|
||||
\func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
|
||||
|
||||
Creates a new input stream on the the specified path. You can use all but seek
|
||||
functionnality of wxStream. Seek isn't available on all stream. For example,
|
||||
http or ftp streams doesn't deal with it. Other functions like Tell
|
||||
aren't available for the moment for this sort of stream.
|
||||
Creates a new input stream on the the specified path. You can use all but the seek
|
||||
functionality of wxStream. Seek isn't available on all streams. For example,
|
||||
http or ftp streams do not deal with it. Other functions like Tell
|
||||
are not available for this sort of stream, at present.
|
||||
You will be notified when the EOF is reached by an error.
|
||||
|
||||
\wxheading{Return value}
|
||||
@@ -183,10 +183,10 @@ You will be notified when the EOF is reached by an error.
|
||||
Returns NULL if an error occured (it could be a network failure or the fact
|
||||
that the file doesn't exist).
|
||||
|
||||
Returns the initialized stream. You will have to delete it yourself once you
|
||||
don't use it anymore. The destructor close the DATA stream connection but
|
||||
will leave the COMMAND stream connection opened. It means that you still
|
||||
can send new commands without reconnecting.
|
||||
Returns the initialized stream. You will have to delete it yourself when you
|
||||
don't need it anymore. The destructor closes the DATA stream connection but
|
||||
will leave the COMMAND stream connection opened. It means that you can still
|
||||
send new commands without reconnecting.
|
||||
|
||||
\wxheading{Example of a standalone connection (without wxURL)}
|
||||
|
||||
|
||||
@@ -730,10 +730,10 @@ wxCANCEL.}
|
||||
wxYES\_NO or wxOK.}
|
||||
\twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
|
||||
\twocolitem{wxCENTRE}{Centres the text.}
|
||||
\twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
|
||||
\twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
|
||||
\twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
|
||||
\twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
|
||||
\twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
|
||||
\twocolitem{wxICON\_HAND}{Displays a hand symbol.}
|
||||
\twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
|
||||
\twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
|
||||
\end{twocollist}
|
||||
|
||||
The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
|
||||
|
||||
@@ -2,6 +2,10 @@
|
||||
|
||||
wxGrid is a class for displaying and editing tabular information.
|
||||
|
||||
{\bf Note:} there is a new grid implementation from wxWindows 2.1.14,
|
||||
with an API that is backwardly compatible with the one documented here.
|
||||
This documentation is awaiting updates for the new and improved API.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxPanel}{wxpanel}\\
|
||||
@@ -338,7 +342,7 @@ Returns the row scroll position.
|
||||
|
||||
\membersection{wxGrid::GetTextItem}\label{wxgridgettextitem}
|
||||
|
||||
\constfunc{wxText *}{GetTextItem}{\void}
|
||||
\constfunc{wxTextCtrl *}{GetTextItem}{\void}
|
||||
|
||||
Returns a pointer to the text item used for entering text into a cell.
|
||||
|
||||
@@ -382,7 +386,7 @@ and rows numerically.
|
||||
\func{void}{OnChangeSelectionLabel}{\void}
|
||||
|
||||
Called when a cell is selected, to allow the application an
|
||||
opportunity to update the selection label (the label of the wxText item
|
||||
opportunity to update the selection label (the label of the wxTextCtrl
|
||||
used for entering cell text). By default, the cell column letter and row
|
||||
number are concatenated to form the selection label.
|
||||
|
||||
|
||||
@@ -33,11 +33,10 @@ There are currently the following help controller classes defined:
|
||||
\item wxWinHelpController, for controlling Windows Help.
|
||||
\item wxExtHelpController, for controlling external browsers under Unix.
|
||||
The default browser is Netscape Navigator. The 'help' sample shows its use.
|
||||
\item wxHelpControllerHtml, using \helpref{wxHTML}{wxhtml} to display help. The API for this class
|
||||
is reasonably close to the wxWindows help controller API; see {\tt wx/helpwxht.h} for
|
||||
\item wxHelpControllerHtml, using \helpref{wxHTML}{wxhtml} to display help. See {\tt wx/helpwxht.h} for
|
||||
details of use.
|
||||
\item \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}, a more sophisticated help controller using \helpref{wxHTML}{wxhtml}, in
|
||||
a similar style to the Windows HTML Help viewer and using some of the same files.
|
||||
a similar style to the Microsoft HTML Help viewer and using some of the same files.
|
||||
Although it has an API compatible with other help controllers, it has more advanced features, so it is
|
||||
recommended that you use the specific API for this class instead.
|
||||
\end{itemize}
|
||||
@@ -80,8 +79,8 @@ Destroys the help instance, closing down the viewer if it is running.
|
||||
|
||||
\func{virtual void}{Initialize}{\param{const wxString\& }{file}, \param{int}{ server}}
|
||||
|
||||
Initializes the help instance with a help filename, and optionally a server (socket)
|
||||
number if using wxHelp. Does not invoke the help viewer.
|
||||
Initializes the help instance with a help filename, and optionally a server socket
|
||||
number if using wxHelp (now obsolete). Does not invoke the help viewer.
|
||||
This must be called directly after the help instance object is created and before
|
||||
any attempts to communicate with the viewer.
|
||||
|
||||
|
||||
@@ -186,10 +186,10 @@ Returns width of the cell (m\_Width member).
|
||||
|
||||
\func{virtual void}{Layout}{\param{int }{w}}
|
||||
|
||||
This method performs 2 actions:
|
||||
This method performs two actions:
|
||||
|
||||
\begin{enumerate}\itemsep=0pt
|
||||
\item adjusts cell's width according to the fact that maximal possible width is {\it w}.
|
||||
\item adjusts the cell's width according to the fact that maximal possible width is {\it w}.
|
||||
(this has sense when working with horizontal lines, tables etc.)
|
||||
\item prepares layout (=fill-in m\_PosX, m\_PosY (and sometimes m\_Height) members)
|
||||
based on actual width {\it w}
|
||||
@@ -203,7 +203,7 @@ before calling Layout.
|
||||
|
||||
\func{virtual void}{OnMouseClick}{\param{wxWindow* }{parent}, \param{int}{x}, \param{int }{y}, \param{const wxMouseEvent\& }{event}}
|
||||
|
||||
This function is simple event handler. Each time user clicks mouse button over a cell
|
||||
This function is simple event handler. Each time the user clicks mouse button over a cell
|
||||
within \helpref{wxHtmlWindow}{wxhtmlwindow} this method of that cell is called. Default behavior is
|
||||
that it calls \helpref{wxHtmlWindow::LoadPage}{wxhtmlwindowloadpage}.
|
||||
|
||||
@@ -233,7 +233,7 @@ is \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}("", "") (no link))
|
||||
\func{void}{SetNext}{\param{wxHtmlCell }{*cell}}
|
||||
|
||||
Sets the next cell in the list. This shouldn't be called by user - it is
|
||||
to be used only by \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}
|
||||
to be used only by \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}.
|
||||
|
||||
\membersection{wxHtmlCell::SetParent}\label{wxhtmlcellsetparent}
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
\section{\class{wxHtmlColourCell}}\label{wxhtmlcolourcell}
|
||||
|
||||
This cell changes color of either background or foreground.
|
||||
This cell changes the colour of either the background or the foreground.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
|
||||
@@ -59,7 +59,7 @@ instead.
|
||||
|
||||
Returns the indentation. {\it ind} is one of the {\bf wxHTML\_INDENT\_*} constants.
|
||||
|
||||
{\bf Note:} You must call \helpref{GetIndentUnits}{wxhtmlcontainercellgetindentunits}
|
||||
{\bf Note:} You must call \helpref{GetIndentUnits}{wxhtmlcontainercellgetindentunits}
|
||||
with same {\it ind} parameter in order to correctly interpret the returned integer value.
|
||||
It is NOT always in pixels!
|
||||
|
||||
@@ -82,14 +82,14 @@ Inserts new cell into the container.
|
||||
|
||||
Sets the container's alignment (both horizontal and vertical) according to
|
||||
the values stored in {\it tag}. (Tags {\tt ALIGN} parameter is extracted.) In fact
|
||||
it is only a front-end to \helpref{SetAlignHor}{wxhtmlcontainercellsetalignhor}
|
||||
it is only a front-end to \helpref{SetAlignHor}{wxhtmlcontainercellsetalignhor}
|
||||
and \helpref{SetAlignVer}{wxhtmlcontainercellsetalignver}.
|
||||
|
||||
\membersection{wxHtmlContainerCell::SetAlignHor}\label{wxhtmlcontainercellsetalignhor}
|
||||
|
||||
\func{void}{SetAlignHor}{\param{int }{al}}
|
||||
|
||||
Sets the container's {\it horizontal alignment}. During \helpref{Layout}{wxhtmlcelllayout}
|
||||
Sets the container's {\it horizontal alignment}. During \helpref{Layout}{wxhtmlcelllayout}
|
||||
each line is aligned according to {\it al} value.
|
||||
|
||||
\wxheading{Parameters}
|
||||
@@ -127,19 +127,19 @@ Sets the container's {\it vertical alignment}. This is per-line alignment!
|
||||
|
||||
\func{void}{SetBackgroundColour}{\param{const wxColour\& }{clr}}
|
||||
|
||||
Sets the background color for this container.
|
||||
Sets the background colour for this container.
|
||||
|
||||
\membersection{wxHtmlContainerCell::SetBorder}\label{wxhtmlcontainercellsetborder}
|
||||
|
||||
\func{void}{SetBorder}{\param{const wxColour\& }{clr1}, \param{const wxColour\& }{clr2}}
|
||||
|
||||
Sets the border (frame) colours. Border is rectangle around the container.
|
||||
Sets the border (frame) colours. A border is a rectangle around the container.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{clr1}{Color of top and left lines}
|
||||
\docparam{clr1}{Colour of top and left lines}
|
||||
|
||||
\docparam{clr2}{Color of bottom and right lines}
|
||||
\docparam{clr2}{Colour of bottom and right lines}
|
||||
|
||||
\membersection{wxHtmlContainerCell::SetIndent}\label{wxhtmlcontainercellsetindent}
|
||||
|
||||
@@ -194,8 +194,8 @@ much smaller area.
|
||||
|
||||
\docparam{align}{If height of the container is lower than the minimum height, empty space must be inserted
|
||||
somewhere in order to ensure minimal height. This parameter is one of {\bf wxHTML\_ALIGN\_TOP,
|
||||
wxHTML\_ALIGN\_BOTTOM, wxHTML\_ALIGN\_CENTER} constants. It refers to the {\it contents}, not to the
|
||||
empty place!}
|
||||
wxHTML\_ALIGN\_BOTTOM, wxHTML\_ALIGN\_CENTER}. It refers to the {\it contents}, not to the
|
||||
empty place.}
|
||||
|
||||
\membersection{wxHtmlContainerCell::SetWidthFloat}\label{wxhtmlcontainercellsetwidthfloat}
|
||||
|
||||
|
||||
@@ -5,9 +5,9 @@
|
||||
|
||||
\section{\class{wxHtmlHelpController}}\label{wxhtmlhelpcontroller}
|
||||
|
||||
{\bf WARNING! Although this class has an API compatible with other wxWindows
|
||||
{\bf WARNING!} Although this class has an API compatible with other wxWindows
|
||||
help controllers as documented by \helpref{wxHelpController}{wxhelpcontroller}, it
|
||||
is recommended that you use the enhanced capabilities of wxHtmlHelpController's API.}
|
||||
is recommended that you use the enhanced capabilities of wxHtmlHelpController's API.
|
||||
|
||||
This help controller provides an easy way of displaying HTML help in your
|
||||
application (see {\it test} sample). The help system is based on {\bf books}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
This class stores all neccessary information about hypertext
|
||||
links (as represented by {\tt <A>} tag in HTML documents). In
|
||||
current implementation it stores URL and target frame name.
|
||||
current implementation it stores URL and target frame name.
|
||||
{\it Note that frames are not currently supported by wxHTML!}
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
@@ -30,7 +30,6 @@ wxObject
|
||||
|
||||
<wx/html/htmlpars.h>
|
||||
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{Cells Overview}{cells},
|
||||
|
||||
@@ -13,7 +13,7 @@ The purpose of this class is to display HTML pages (either local
|
||||
file or downloaded via HTTP protocol) in a window. The width
|
||||
of the window is constant - given in the constructor - and virtual height
|
||||
is changed dynamically depending on page size.
|
||||
Once the window is created you can set its content by calling
|
||||
Once the window is created you can set its content by calling
|
||||
\helpref{SetPage(text)}{wxhtmlwindowsetpage} or
|
||||
\helpref{LoadPage(filename)}{wxhtmlwindowloadpage}.
|
||||
|
||||
|
||||
+18
-37
@@ -3,25 +3,21 @@
|
||||
% htmlwinparser.tex at 14/Mar/99 20:13:37
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxHtmlWinParser}}\label{wxhtmlwinparser}
|
||||
|
||||
This class is derived from \helpref{wxHtmlParser}{wxhtmlparser} and
|
||||
its mail goal is to parse HTML input so that it can be displayed in
|
||||
\helpref{wxHtmlWindow}{wxhtmlwindow}. It uses special
|
||||
\helpref{wxHtmlWindow}{wxhtmlwindow}. It uses a special
|
||||
\helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}.
|
||||
|
||||
\wxheading{Notes}
|
||||
|
||||
\begin{enumerate}
|
||||
\item Product of parsing is wxHtmlCell (resp. wxHtmlContainer) object.
|
||||
\end{enumerate}
|
||||
The product of parsing is a wxHtmlCell (resp. wxHtmlContainer) object.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxHtmlParser}{wxhtmlparser}
|
||||
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/html/winpars.h>
|
||||
@@ -58,21 +54,21 @@ and returns pointer to it (see \helpref{Overview}{cells}).
|
||||
|
||||
\func{virtual wxFont*}{CreateCurrentFont}{\void}
|
||||
|
||||
Creates font based on current setting (see
|
||||
\helpref{SetFontSize}{wxhtmlwinparsersetfontsize},
|
||||
\helpref{SetFontBold}{wxhtmlwinparsersetfontbold},
|
||||
\helpref{SetFontItalic}{wxhtmlwinparsersetfontitalic},
|
||||
\helpref{SetFontFixed}{wxhtmlwinparsersetfontfixed},
|
||||
Creates font based on current setting (see
|
||||
\helpref{SetFontSize}{wxhtmlwinparsersetfontsize},
|
||||
\helpref{SetFontBold}{wxhtmlwinparsersetfontbold},
|
||||
\helpref{SetFontItalic}{wxhtmlwinparsersetfontitalic},
|
||||
\helpref{SetFontFixed}{wxhtmlwinparsersetfontfixed},
|
||||
\helpref{SetFontUnderlined}{wxhtmlwinparsersetfontunderlined})
|
||||
and returns pointer to it.
|
||||
(If the font was already created only a pointer is returned.)
|
||||
If the font was already created only a pointer is returned.
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor}
|
||||
|
||||
\constfunc{const wxColour\&}{GetActualColor}{\void}
|
||||
|
||||
Returns actual text color.
|
||||
Returns actual text colour.
|
||||
|
||||
\membersection{wxHtmlWinParser::GetAlign}\label{wxhtmlwinparsergetalign}
|
||||
|
||||
@@ -86,7 +82,7 @@ Returns default horizontal alignment.
|
||||
|
||||
Returns (average) char height in standard font. It's used as DC-independent metrics.
|
||||
|
||||
{\bf Note:} This function doesn't return {\it actual} height. If you want to
|
||||
{\bf Note:} This function doesn't return the {\it actual} height. If you want to
|
||||
know the height of the current font, call {\tt GetDC -> GetCharHeight()}.
|
||||
|
||||
\membersection{wxHtmlWinParser::GetCharWidth}\label{wxhtmlwinparsergetcharwidth}
|
||||
@@ -95,7 +91,7 @@ know the height of the current font, call {\tt GetDC -> GetCharHeight()}.
|
||||
|
||||
Returns average char width in standard font. It's used as DC-independent metrics.
|
||||
|
||||
{\bf Note:} This function doesn't return {\it actual} width. If you want to
|
||||
{\bf Note:} This function doesn't return the {\it actual} width. If you want to
|
||||
know the height of the current font, call {\tt GetDC -> GetCharWidth()}
|
||||
|
||||
\membersection{wxHtmlWinParser::GetContainer}\label{wxhtmlwinparsergetcontainer}
|
||||
@@ -115,13 +111,12 @@ m_WParser -> GetContainer() -> InsertCell(new ...);
|
||||
|
||||
Returns pointer to the DC used during parsing.
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::GetEncodingConverter}\label{wxhtmlwinparsergetencodingconverter}
|
||||
|
||||
\constfunc{wxEncodingConverter *}{GetEncodingConverter}{\void}
|
||||
|
||||
Returns \helpref{wxEncodingConverter}{wxencodingconverter} class used
|
||||
to do conversion between \helpref{input encoding}{wxhtmlwinparsergetinputencoding}
|
||||
to do conversion between \helpref{input encoding}{wxhtmlwinparsergetinputencoding}
|
||||
and \helpref{output encoding}{wxhtmlwinparsergetoutputencoding}.
|
||||
|
||||
\membersection{wxHtmlWinParser::GetFontBold}\label{wxhtmlwinparsergetfontbold}
|
||||
@@ -136,7 +131,6 @@ Returns TRUE if actual font is bold, FALSE otherwise.
|
||||
|
||||
Returns actual font face name.
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}
|
||||
|
||||
\constfunc{int}{GetFontFixed}{\void}
|
||||
@@ -149,7 +143,6 @@ Returns TRUE if actual font is fixed face, FALSE otherwise.
|
||||
|
||||
Returns TRUE if actual font is italic, FALSE otherwise.
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize}
|
||||
|
||||
\constfunc{int}{GetFontSize}{\void}
|
||||
@@ -168,23 +161,20 @@ Returns TRUE if actual font is underlined, FALSE otherwise.
|
||||
|
||||
Returns input encoding.
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::GetLink}\label{wxhtmlwinparsergetlink}
|
||||
|
||||
\constfunc{const wxHtmlLinkInfo\&}{GetLink}{\void}
|
||||
|
||||
Returns actual hypertext link. (This value has non-empty
|
||||
Returns actual hypertext link. (This value has a non-empty
|
||||
\helpref{Href}{wxhtmllinkinfogethref} string
|
||||
if the parser is between {\tt <A>} and {\tt </A>} tags,
|
||||
wxEmptyString otherwise.)
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor}
|
||||
|
||||
\constfunc{const wxColour\&}{GetLinkColor}{\void}
|
||||
|
||||
Returns color of hypertext link text.
|
||||
|
||||
Returns the colour of hypertext link text.
|
||||
|
||||
\membersection{wxHtmlWinParser::GetOutputEncoding}\label{wxhtmlwinparsergetoutputencoding}
|
||||
|
||||
@@ -201,37 +191,33 @@ Returns associated window (wxHtmlWindow). This may be NULL! (You should always
|
||||
test if it is non-NULL. For example {\tt TITLE} handler sets window
|
||||
title only if some window is associated, otherwise it does nothing)
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::OpenContainer}\label{wxhtmlwinparseropencontainer}
|
||||
|
||||
\func{wxHtmlContainerCell*}{OpenContainer}{\void}
|
||||
|
||||
Opens new container and returns pointer to it (see \helpref{Overview}{cells}).
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor}
|
||||
|
||||
\func{void}{SetActualColor}{\param{const wxColour\& }{clr}}
|
||||
|
||||
Sets actual text color. Note: this DOESN'T change the color!
|
||||
Sets actual text colour. Note: this DOESN'T change the colour!
|
||||
You must create \helpref{wxHtmlColourCell}{wxhtmlcolourcell} yourself.
|
||||
|
||||
\membersection{wxHtmlWinParser::SetAlign}\label{wxhtmlwinparsersetalign}
|
||||
|
||||
\func{void}{SetAlign}{\param{int }{a}}
|
||||
|
||||
Sets default horizontal alignment (see
|
||||
Sets default horizontal alignment (see
|
||||
\helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.)
|
||||
Alignment of newly opened container is set to this value.
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::SetContainer}\label{wxhtmlwinparsersetcontainer}
|
||||
|
||||
\func{wxHtmlContainerCell*}{SetContainer}{\param{wxHtmlContainerCell *}{c}}
|
||||
|
||||
Allows you to directly set opened container. This is not recommended - you should use OpenContainer
|
||||
whereever possible.
|
||||
|
||||
wherever possible.
|
||||
|
||||
\membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc}
|
||||
|
||||
@@ -243,7 +229,6 @@ DCs (e.g. printer) to adjust size of pixel metrics. (Many dimensions in
|
||||
HTML are given in pixels -- e.g. image sizes. 300x300 image would be only one
|
||||
inch wide on typical printer. With pixel\_scale = 3.0 it would be 3 inches.)
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold}
|
||||
|
||||
\func{void}{SetFontBold}{\param{int }{x}}
|
||||
@@ -270,7 +255,6 @@ Sets fixed face flag of actualfont. {\it x} is either TRUE of FALSE.
|
||||
|
||||
Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize}
|
||||
|
||||
\func{void}{SetFontSize}{\param{int }{s}}
|
||||
@@ -289,7 +273,6 @@ Sets underlined flag of actualfont. {\it x} is either TRUE of FALSE.
|
||||
|
||||
Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::SetInputEncoding}\label{wxhtmlwinparsersetinputencoding}
|
||||
|
||||
\func{void}{SetInputEncoding}{\param{wxFontEncoding }{enc}}
|
||||
@@ -298,7 +281,6 @@ Sets input encoding. The parser uses this information to build conversion
|
||||
tables from document's encoding to some encoding supported by operating
|
||||
system.
|
||||
|
||||
|
||||
\membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink}
|
||||
|
||||
\func{void}{SetLink}{\param{const wxHtmlLinkInfo\& }{link}}
|
||||
@@ -311,6 +293,5 @@ to wxEmptyString.
|
||||
|
||||
\func{void}{SetLinkColor}{\param{const wxColour\& }{clr}}
|
||||
|
||||
Sets color of hypertext link.
|
||||
|
||||
Sets colour of hypertext link.
|
||||
|
||||
|
||||
@@ -74,6 +74,8 @@ Creates an icon from an array of bits.
|
||||
|
||||
Creates a new icon.
|
||||
|
||||
\func{}{wxIcon}{\param{char**}{ bits}}
|
||||
|
||||
\func{}{wxIcon}{\param{const char**}{ bits}}
|
||||
|
||||
Creates an icon from XPM data.
|
||||
|
||||
@@ -18,7 +18,7 @@ creation of a \helpref{wxMask}{wxmask} object associated to the bitmap object.
|
||||
|
||||
The following image handlers are available. {\bf wxBMPHandler} is always
|
||||
installed by default. To use other image formats, install the appropiate
|
||||
handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or
|
||||
handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or
|
||||
\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}.
|
||||
|
||||
\twocolwidtha{5cm}%
|
||||
@@ -116,8 +116,8 @@ Loads an image from an input stream.
|
||||
|
||||
Depending on how wxWindows has been configured, not all formats may be available.
|
||||
|
||||
Note : any handler other than BMP must be previously
|
||||
initialized with \helpref{wxImage::AddHandler}{wximageaddhandler} or
|
||||
Note: any handler other than BMP must be previously
|
||||
initialized with \helpref{wxImage::AddHandler}{wximageaddhandler} or
|
||||
\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}.
|
||||
|
||||
\wxheading{See also}
|
||||
@@ -331,7 +331,7 @@ the user.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxImageHandler}{wximagehandler}
|
||||
\helpref{wxImageHandler}{wximagehandler},
|
||||
\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
|
||||
|
||||
\membersection{wxImage::InsertHandler}
|
||||
@@ -653,7 +653,7 @@ created by IJG.)
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxImage}{wximage}
|
||||
\helpref{wxImage}{wximage},
|
||||
\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -733,8 +733,8 @@ TRUE if the operation succeeded, FALSE otherwise.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxImage::LoadFile}{wximageloadfile}\\
|
||||
\helpref{wxImage::SaveFile}{wximagesavefile}\\
|
||||
\helpref{wxImage::LoadFile}{wximageloadfile},
|
||||
\helpref{wxImage::SaveFile}{wximagesavefile},
|
||||
\helpref{wxImageHandler::SaveFile}{wximagehandlersavefile}
|
||||
|
||||
\membersection{wxImageHandler::SaveFile}\label{wximagehandlersavefile}
|
||||
@@ -755,8 +755,8 @@ TRUE if the operation succeeded, FALSE otherwise.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxImage::LoadFile}{wximageloadfile}\\
|
||||
\helpref{wxImage::SaveFile}{wximagesavefile}\\
|
||||
\helpref{wxImage::LoadFile}{wximageloadfile},
|
||||
\helpref{wxImage::SaveFile}{wximagesavefile},
|
||||
\helpref{wxImageHandler::LoadFile}{wximagehandlerloadfile}
|
||||
|
||||
\membersection{wxImageHandler::SetName}
|
||||
|
||||
@@ -13,6 +13,8 @@ wxInputStream is an abstract base class which may not be used directly.
|
||||
|
||||
<wx/stream.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
% -----------
|
||||
% ctor & dtor
|
||||
% -----------
|
||||
|
||||
@@ -157,8 +157,7 @@ Deletes all the items in the list control.
|
||||
|
||||
{\bf NB:} This function does {\it not} send the
|
||||
{\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event because deleting many items
|
||||
from the control would be too slow then (unlike
|
||||
\helpref{DeleteItem}{wxlistctrldeleteitem})
|
||||
from the control would be too slow then (unlike \helpref{DeleteItem}{wxlistctrldeleteitem}).
|
||||
|
||||
\membersection{wxListCtrl::DeleteColumn}\label{wxlistctrldeletecolumn}
|
||||
|
||||
@@ -331,6 +330,7 @@ Returns the first item with given state following {\it item} or -1 if
|
||||
no such item found.
|
||||
|
||||
This function may be used to find all selected items in the control like this:
|
||||
|
||||
\begin{verbatim}
|
||||
long item = -1;
|
||||
for ( ;; )
|
||||
@@ -413,7 +413,7 @@ wxLIST\_HITTEST\_ONITEMSTATEICON.}
|
||||
\end{twocollist}
|
||||
|
||||
\pythonnote{A tuple of values is returned in the wxPython version of
|
||||
thsi method. The first value is the item id and the second is the
|
||||
this method. The first value is the item id and the second is the
|
||||
flags value mentioned above.}
|
||||
|
||||
\membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn}
|
||||
|
||||
@@ -80,17 +80,21 @@ current mask while a message using string mask will be logged simply if the
|
||||
mask had been added before to the list of allowed ones.
|
||||
|
||||
For example,
|
||||
|
||||
\begin{verbatim}
|
||||
// wxTraceOleCalls is one of standard bit masks
|
||||
wxLogTrace(wxTraceRefCount | wxTraceOleCalls, "Active object ref count: %d", nRef);
|
||||
\end{verbatim}
|
||||
will do something only if the current trace mask contains both
|
||||
{\tt wxTraceRefCount} and {\tt wxTraceOle}, but
|
||||
|
||||
\begin{verbatim}
|
||||
// wxTRACE_OleCalls is one of standard string masks
|
||||
wxLogTrace(wxTRACE_OleCalls, "IFoo::Bar() called");
|
||||
\end{verbatim}
|
||||
|
||||
will log the message if it was preceded by
|
||||
|
||||
\begin{verbatim}
|
||||
wxLog::AddTraceMask(wxTRACE_OleCalls);
|
||||
\end{verbatim}
|
||||
|
||||
@@ -254,7 +254,7 @@ Second form: returns the menu item object, or NULL if it is not found.
|
||||
Any special menu codes are stripped out of source and target strings
|
||||
before matching.
|
||||
|
||||
\pythonnote{The name of this method in wxPython is {\tt FindItemById}
|
||||
\pythonnote{The name of this method in wxPython is {\tt FindItemById}
|
||||
and it does not support the second parameter.}
|
||||
|
||||
\membersection{wxMenu::GetHelpString}\label{wxmenugethelpstring}
|
||||
@@ -706,8 +706,8 @@ Returns the number of menus in this menubar.
|
||||
\func{bool}{Insert}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}}
|
||||
|
||||
Inserts the menu at the given position into the menu bar. Inserting menu at
|
||||
position $0$ will insert it in the very beginning of it, inserting at position
|
||||
\helpref{GetMenuCount()}{wxmenubargetmenucount} is the same as calling
|
||||
position $0$ will insert it in the very beginning of it, inserting at position
|
||||
\helpref{GetMenuCount()}{wxmenubargetmenucount} is the same as calling
|
||||
\helpref{Append()}{wxmenubarappend}.
|
||||
|
||||
\wxheading{Parameters}
|
||||
@@ -765,7 +765,7 @@ Redraw the menu bar
|
||||
\func{wxMenu *}{Remove}{\param{size\_t }{pos}}
|
||||
|
||||
Removes the menu from the menu bar and returns the menu object - the caller is
|
||||
reposnbile for deleting it. This function may be used together with
|
||||
reposnbile for deleting it. This function may be used together with
|
||||
\helpref{wxMenuBar::Insert}{wxmenubarinsert} to change the menubar
|
||||
dynamically.
|
||||
|
||||
@@ -777,7 +777,7 @@ dynamically.
|
||||
|
||||
\func{wxMenu *}{Replace}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}}
|
||||
|
||||
Replaces the menu at givenm position with another one.
|
||||
Replaces the menu at the given position with another one.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
|
||||
@@ -104,7 +104,7 @@ characaters it might contain.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{GetText}{wxmenuitemgettext},
|
||||
\helpref{GetText}{wxmenuitemgettext},
|
||||
\helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext}
|
||||
|
||||
\membersection{wxMenuItem::GetLabelFromText}\label{wxmenuitemgetlabelfromtext}
|
||||
@@ -122,7 +122,7 @@ will return just {\tt "Hello"}.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{GetText}{wxmenuitemgettext},
|
||||
\helpref{GetText}{wxmenuitemgettext},
|
||||
\helpref{GetLabel}{wxmenuitemgetlabel}
|
||||
|
||||
\membersection{wxMenuItem::GetMarginWidth}\label{wxmenuitemgetmarginwidth}
|
||||
@@ -150,7 +150,7 @@ wxMenuItem constructor, i.e. with any accelerator characters it may contain.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{GetLabel}{wxmenuitemgetlabel},
|
||||
\helpref{GetLabel}{wxmenuitemgetlabel},
|
||||
\helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext}
|
||||
|
||||
\membersection{wxMenuItem::GetSubMenu}\label{wxmenuitemgetsubmenu}
|
||||
@@ -233,9 +233,3 @@ Sets the text associated with the menu item.
|
||||
|
||||
Sets the text colour associated with the menu item (Windows only).
|
||||
|
||||
|
||||
|
||||
%%% Local Variables:
|
||||
%%% mode: latex
|
||||
%%% TeX-master: "referenc"
|
||||
%%% End:
|
||||
|
||||
@@ -188,7 +188,9 @@ See also \helpref{wxMouseEvent::Leaving}{wxmouseeventleaving}.
|
||||
|
||||
\constfunc{wxPoint}{GetPosition}{\void}
|
||||
|
||||
\constfunc{void}{GetPosition}{\param{long *}{x}, \param{long *}{y}}
|
||||
\constfunc{void}{GetPosition}{\param{wxCoord*}{ x}, \param{wxCoord*}{ y}}
|
||||
|
||||
\constfunc{void}{GetPosition}{\param{long*}{ x}, \param{long*}{ y}}
|
||||
|
||||
Sets *x and *y to the position at which the event occurred.
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user