Minor doc & distrib file changes
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3460 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -18,13 +18,11 @@ progress bar. Optionally, it can display an ABORT button.
|
||||
|
||||
\membersection{wxProgressDialog::wxProgressDialog}\label{wxprogressdialogconstr}
|
||||
|
||||
\func{}{wxProgressDialog}
|
||||
{\param{const wxString\& }{title},
|
||||
\param{const wxString\& }{message},\rtfsp
|
||||
\param{int }{maximum = 100},
|
||||
\param{wxWindow * }{parent = NULL},\rtfsp
|
||||
\param{int }{style = wxPD\_AUTO\_HIDE | wxPD\_APP\_MODAL}
|
||||
}
|
||||
\func{}{wxProgressDialog}{\param{const wxString\& }{title},
|
||||
\param{const wxString\& }{message},\rtfsp
|
||||
\param{int }{maximum = 100},
|
||||
\param{wxWindow * }{parent = NULL},\rtfsp
|
||||
\param{int }{style = wxPD\_AUTO\_HIDE | wxPD\_APP\_MODAL}}
|
||||
|
||||
Constructor. Creates the dialog, displays it and disables user input
|
||||
for other windows, or, if wxPD\_APP\_MODAL flag is not given, for its parent
|
||||
@@ -43,20 +41,20 @@ window only.
|
||||
\docparam{message}{Message to show on the dialog.}
|
||||
|
||||
\docparam{style}{The dialog style. This is the combination of the following
|
||||
bitmask constants defined in wx/defs.h:
|
||||
bitmask constants defined in wx/defs.h:
|
||||
|
||||
\twocolwidtha{7cm}
|
||||
\begin{twocollist}\itemsep=0pt
|
||||
\twocolitem{wxPD\_APP\_MODAL}{Make the progress dialog modal. If this flag is
|
||||
not given, it is only "locally" modal - that is the input to the parent
|
||||
window is disabled, but not to the other ones.}
|
||||
not given, it is only "locally" modal - that is the input to the parent
|
||||
window is disabled, but not to the other ones.}
|
||||
\twocolitem{wxPD\_AUTO\_HIDE}{By default, the progress dialog will disappear
|
||||
from screen as soon as the maximum value of the progress meter has been
|
||||
reached. This flag prevents it from doing it - instead the dialog will wait
|
||||
until the user closes it.}
|
||||
from screen as soon as the maximum value of the progress meter has been
|
||||
reached. This flag prevents it from doing it - instead the dialog will wait
|
||||
until the user closes it.}
|
||||
\twocolitem{wxPD\_CAN\_ABORT}{This flag tells the dialog that it should have a
|
||||
"Cancel" button which the user may press. If this happens, the next call to
|
||||
\helpref{Update()}{wxprogressdialogupdate} will return FALSE.}
|
||||
"Cancel" button which the user may press. If this happens, the next call to
|
||||
\helpref{Update()}{wxprogressdialogupdate} will return FALSE.}
|
||||
\twocolitem{wxPD\_ELAPSED\_TIME}{This flag tells the dialog that it should show elapsed time (since creating the dialog).}
|
||||
\twocolitem{wxPD\_ESTIMATED\_TIME}{This flag tells the dialog that it should show estimated time.}
|
||||
\twocolitem{wxPD\_REMAINING\_TIME}{This flag tells the dialog that it should show remaining time.}
|
||||
@@ -66,8 +64,8 @@ window only.
|
||||
\membersection{wxProgressDialog::\destruct{wxProgressDialog}}
|
||||
|
||||
\func{}{\destruct{wxMessageDialog}}{\void}
|
||||
Destructor.
|
||||
Deletes the dialog and enables all top level windows.
|
||||
|
||||
Destructor. Deletes the dialog and enables all top level windows.
|
||||
|
||||
\membersection{wxProgressDialog::Update}\label{wxprogressdialogupdate}
|
||||
|
||||
@@ -84,10 +82,10 @@ or ask the user for the confirmation and if the abort is not confirmed the
|
||||
dialog may be resumed with \helpref{Resume}{wxprogressdialogresume} function.
|
||||
|
||||
\docparam{value}{The new value of the progress meter. It must be strictly less
|
||||
than the maximum value given to the constructor (i.e., as usual in C, the
|
||||
index runs from $0$ to $maximum-1$).}
|
||||
than the maximum value given to the constructor (i.e., as usual in C, the
|
||||
index runs from $0$ to $maximum-1$).}
|
||||
\docparam{newmsg}{The new messages for the progress dialog text, if none is
|
||||
given the message is not changed.}
|
||||
given the message is not changed.}
|
||||
|
||||
\membersection{wxProgressDialog::Resume}\label{wxprogressdialogresume}
|
||||
|
||||
|
@@ -34,10 +34,11 @@ can call directly wxStreamBuffer::Read without any problems.
|
||||
\wxheading{Warning}
|
||||
|
||||
All errors and messages linked to the stream are stored in the stream object.
|
||||
|
||||
\begin{verbatim}
|
||||
streambuffer.Read(...);
|
||||
streambuffer2.Read(...); /* This one erases previous error messages set by
|
||||
``streambuffer'' */
|
||||
streambuffer.Read(...);
|
||||
streambuffer2.Read(...); /* This one erases previous error messages set by
|
||||
``streambuffer'' */
|
||||
\end{verbatim}
|
||||
|
||||
\func{}{wxStreamBuffer}{\param{BufMode}{ mode}}
|
||||
|
@@ -8,17 +8,18 @@ Classes: \helpref{wxStreamBase}{wxstreambase},
|
||||
|
||||
\wxheading{Purpose of wxStream}
|
||||
|
||||
We went into troubles with C++ std streams on several platforms:
|
||||
they react quite well in most cases, but in multi-threaded case, for example,
|
||||
We had troubles with standard C++ streams on several platforms:
|
||||
they react quite well in most cases, but in the multi-threaded case, for example,
|
||||
they have many problems. Some Borland Compilers refuse to work at all
|
||||
with them and using iostreams on Linux makes writing programs, that are
|
||||
binary compatible across different Linux distributions, impossible.
|
||||
|
||||
Therefore, wxStreams have been added to wxWindows because an application should
|
||||
compile and run on all supported platforms and we don't want users depend on release
|
||||
compile and run on all supported platforms and we don't want users to depend on release
|
||||
X.XX of libg++ or some other compiler to run the program.
|
||||
|
||||
wxStreams is divided in two main parts:
|
||||
|
||||
\begin{enumerate}\itemsep=0pt
|
||||
\item the core: wxStreamBase, wxStreamBuffer, wxInputStream, wxOutputStream,
|
||||
wxFilterIn/OutputStream
|
||||
@@ -50,7 +51,7 @@ wxStreamBuffer. This could also be a simple link to the a true syscall
|
||||
|
||||
\wxheading{Generic usage: an example}
|
||||
|
||||
About its usage, it's simple. We can take the example of wxFileInputStream and here is a sample
|
||||
Usage is simple. We can take the example of wxFileInputStream and here is some sample
|
||||
code:
|
||||
|
||||
\begin{verbatim}
|
||||
@@ -84,7 +85,7 @@ code:
|
||||
// wxFileInputStream will close the file descriptor on the destruction.
|
||||
\end{verbatim}
|
||||
|
||||
\wxheading{Compatibility with c++ stream}
|
||||
\wxheading{Compatibility with C++ streams}
|
||||
|
||||
As I said previously, we could add a filter stream so it takes an istream
|
||||
argument and builds a wxInputStream from it: I don't think it should
|
||||
|
Reference in New Issue
Block a user