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:
Julian Smart
1999-08-24 13:04:55 +00:00
parent f786a3b23d
commit 2723cfeba2
9 changed files with 120 additions and 83 deletions

View File

@@ -6,6 +6,7 @@ autogen.sh
config.guess
config.sub
configure.in
setup.h.in
install-sh
ltconfig
ltmain.sh
@@ -40,6 +41,9 @@ docs/html/*.gif
src/*.inc
src/mkdir
src/Makefile
src/make.env.in
src/makeprog.env.in
src/makelib.env.in
src/common/*.cpp
src/common/dosyacc.c
@@ -205,6 +209,20 @@ utils/dialoged/test/*.ico
utils/dialoged/test/*.prj
utils/dialoged/test/*.bmp
utils/wxMMedia2/makefile*
utils/wxMMedia2/README
utils/wxMMedia2/lib/*.h
utils/wxMMedia2/lib/*.cpp
utils/wxMMedia2/lib/*.def
utils/wxMMedia2/lib/*.rc
utils/wxMMedia2/lib/makefile*
utils/wxMMedia2/sample/*.h
utils/wxMMedia2/sample/*.cpp
utils/wxMMedia2/sample/makefile*
utils/wxMMedia2/sample/*.xbm
utils/wxMMedia2/sample/*.xpm
utils/wxMMedia2/sample/*.txt
samples/*.txt
samples/makefile*
@@ -877,3 +895,15 @@ samples/text/*.png
samples/text/*.ico
samples/text/*.txt
samples/wizard/*.cpp
samples/wizard/*.h
samples/wizard/makefile*
samples/wizard/*.rc
samples/wizard/*.def
samples/wizard/*.bmp
samples/wizard/*.xpm
samples/wizard/*.xbm
samples/wizard/*.png
samples/wizard/*.ico
samples/wizard/*.txt

View File

@@ -1,80 +1,74 @@
src/Makefile
locale/Makefile
Makefile.am
include/Makefile.am
include/wx/Makefile.am
include/wx/generic/Makefile.am
include/wx/gtk/Makefile.am
include/wx/html/Makefile.am
include/wx/motif/Makefile.am
samples/Makefile.in
samples/bombs/Makefile.in
samples/caret/Makefile.in
samples/checklst/Makefile.in
samples/config/Makefile.in
samples/controls/Makefile.in
samples/dialogs/Makefile.in
samples/dnd/Makefile.in
samples/docview/Makefile.in
samples/docvwmdi/Makefile.in
samples/drawing/Makefile.in
samples/dynamic/Makefile.in
samples/genvalid/Makefile.in
samples/html/Makefile.in
samples/html/about/Makefile.in
samples/html/help/Makefile.in
samples/html/printing/Makefile.in
samples/html/test/Makefile.in
samples/html/virtual/Makefile.in
samples/html/widget/Makefile.in
samples/html/zip/Makefile.in
samples/image/Makefile.in
samples/layout/Makefile.in
samples/listctrl/Makefile.in
samples/mdi/Makefile.in
samples/minifram/Makefile.in
samples/minimal/Makefile.in
samples/notebook/Makefile.in
samples/printing/Makefile.in
samples/proplist/Makefile.in
samples/sashtest/Makefile.in
samples/scroll/Makefile.in
samples/splitter/Makefile.in
samples/text/Makefile.in
samples/thread/Makefile.in
samples/toolbar/Makefile.in
samples/treectrl/Makefile.in
samples/typetest/Makefile.in
samples/validate/Makefile.in
samples/wizard/Makefile.in
samples/wxpoem/Makefile.in
samples/wxsocket/Makefile.in
utils/Makefile.in
utils/wxMMedia2/Makefile.in
utils/wxMMedia2/lib/Makefile.in
utils/wxMMedia2/sample/Makefile.in
include/wx/msw/Makefile.am
include/wx/msw/ctl3d/Makefile.am
include/wx/msw/gnuwin32/Makefile.am
include/wx/protocol/Makefile.am
include/wx/unix/Makefile.am
misc/Makefile.am
misc/afm/Makefile.am
misc/gs_afm/Makefile.am
samples/Makefile.am
samples/bombs/Makefile.am
samples/caret/Makefile.am
samples/checklst/Makefile.am
samples/config/Makefile.am
samples/controls/Makefile.am
samples/animatn/Makefile.am
samples/db/Makefile.am
samples/dialogs/Makefile.am
samples/dnd/Makefile.am
samples/docview/Makefile.am
samples/docvwmdi/Makefile.am
samples/drawing/Makefile.am
samples/dynamic/Makefile.am
samples/forty/Makefile.am
samples/fractal/Makefile.am
samples/grid/Makefile.am
samples/help/Makefile.am
samples/html/Makefile.am
samples/html/about/Makefile.am
samples/html/help/Makefile.am
samples/html/printing/Makefile.am
samples/html/test/Makefile.am
samples/html/virtual/Makefile.am
samples/html/widget/Makefile.am
samples/html/zip/Makefile.am
samples/image/Makefile.am
samples/internat/Makefile.am
samples/joytest/Makefile.am
samples/layout/Makefile.am
samples/listctrl/Makefile.am
samples/mdi/Makefile.am
samples/memcheck/Makefile.am
samples/mfc/Makefile.am
samples/minifram/Makefile.am
samples/minimal/Makefile.am
samples/nativdlg/Makefile.am
samples/notebook/Makefile.am
samples/oleauto/Makefile.am
samples/ownerdrw/Makefile.am
samples/png/Makefile.am
samples/printing/Makefile.am
samples/proplist/Makefile.am
samples/regtest/Makefile.am
samples/resource/Makefile.am
samples/richedit/Makefile.am
samples/sashtest/Makefile.am
samples/scroll/Makefile.am
samples/splitter/Makefile.am
samples/tab/Makefile.am
samples/taskbar/Makefile.am
samples/text/Makefile.am
samples/thread/Makefile.am
samples/toolbar/Makefile.am
samples/treectrl/Makefile.am
samples/typetest/Makefile.am
samples/validate/Makefile.am
samples/wxpoem/Makefile.am
samples/wxsocket/Makefile.am
src/Makefile.am
src/gtk/Makefile.am
src/motif/Makefile.am
src/msw/Makefile.am

View File

@@ -260,6 +260,7 @@ programming.
<li><a href="../../samples/typetest">typetest</a>: tests various data type classes, including
wxTime, wxDate and wxVariant.
<li><a href="../../samples/validate">validate</a>: shows simple use of validation.
<li><a href="../../samples/wizard">wizard</a>: demonstrates the wxWizard class.
<li><a href="../../samples/wxpoem">wxpoem</a>: a little poetry display program.
<li><a href="../../samples/wxsocket">wxsocket</a>: demonstrates the TCP/IP family of classes.
</ul>

View File

@@ -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}

View File

@@ -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}}

View File

@@ -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

View File

@@ -313,7 +313,7 @@ HTMLOBJS = \
# Add $(NONESSENTIALOBJS) if wanting generic dialogs, PostScript etc.
# Add $(HTMLOBJS) if wanting wxHTML classes
OBJECTS = $(COMMONOBJS) $(GENERICOBJS) $(MSWOBJS)
OBJECTS = $(COMMONOBJS) $(GENERICOBJS) $(MSWOBJS) $(HTMLOBJS)
# Normal, static library
all: dirs $(DUMMYOBJ) $(OBJECTS) $(PERIPH_TARGET) png zlib xpm jpeg $(LIBTARGET)

View File

@@ -1,5 +1,5 @@
[OPTIONS]
BMROOT=d:\wx2\wxWind~1\utils\tex2rtf\docs ; Assume that bitmaps are where the source is
BMROOT=d:\wx2\wxwind~1\utils\tex2rtf\docs ; Assume that bitmaps are where the source is
TITLE=Tex2RTF Manual
CONTENTS=Contents
COMPRESS=HIGH

View File

@@ -111,6 +111,13 @@ a great help in giving advice for improvements to the manual.
\section{Change log}\index{change log}%
Version 1.65, August 24th 1999
\begin{itemize}\itemsep=0pt
\item Added htmlWorkshopFiles setting, to output .hpp, .hhc
and .hhk (HTML Workshop) files, for generating MS HTML Help or wxHTML Help.
\end{itemize}
Version 1.64, October 20th 1998
\begin{itemize}\itemsep=0pt
@@ -669,6 +676,11 @@ and truncates filenames within HTML documents.}
\twocolitem{\inioption{htmlIndex}}{If true, specifies generation of an {\tt .htx} index file for an HTML document.
This file can be used in wxHelp version 2 or other programs. The file consists of a number of lines,
each line with three fields separated by bar characters: the indexed phrase, the file, and a label in the file.}
\twocolitem{\inioption{htmlWorkshopFiles}}{If true, specifies generation of {\tt .hpp, .hhc} and {\tt .hhk} files
which can be used to create both MS HTML Help and wxHTML Help files. wxHTML Help
is the HTML help facility that can be used by wxWindows 2 applications (see the wxWindows manual
and the wxWindows HTML sample).}
\twocolitem{\inioption{upperCaseNames}}{If true, filenames in links are in upper case. By default
filenames are in lower case.}
\twocolitem{\inioption{backgroundColour}}{Specifies the RGB background colour for the document, e.g. {\tt 255;255;255} for white.