Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixed some doc problems

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3569 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
1999-09-05 19:42:03 +00:00
parent 1044a386f0
commit 7e9a386e10
6 changed files with 108 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/latex/wx/boxsizer.tex
View File

@@ -16,8 +16,8 @@ the buttons shall be centred as the width of the dialog changes.
It is the unique feature of a box sizer, that it can grow in both directions (height and
width) but can distribute its growth in the main direction (horizontal for a row) {\it unevenly}
among its children. In our example case, the vertical sizer is supposed to propagate all its
height changes to only the text area, not to the button area. This is determined by the
{\it option} parameter when adding a window (or another sizer) to a sizer. It is interpreted
height changes to only the text area, not to the button area. This is determined by the {\it option} parameter
when adding a window (or another sizer) to a sizer. It is interpreted
as a weight factor, i.e. it can be zero, indicating that the window may not be resized
at all, or above zero. If several windows have a value above zero, the value is interpreted
relative to the sum of all weight factors of the sizer, so when adding two windows with
@@ -77,11 +77,9 @@ MyDialog::MyDialog(wxFrame *parent, wxWindowID id, const wxString &title ) :
topsizer->Fit( this ); // set size to minimum size as calculated by the sizer
topsizer->SetSizeHints( this ); // set size hints to honour mininum size
}
\end{verbatim}
\wxheading{Derived from}
\helpref{wxSizer}{wxsizer}

1
docs/latex/wx/sbsizer.tex
View File

@@ -27,3 +27,4 @@ as parameters - orient can be either of wxVERTICAL or wxHORIZONTAL.
\func{wxStaticBox*}{GetStaticBox}{\void}
Returns the static box associated with the sizer.

12
docs/latex/wx/sizer.tex
View File

@@ -1,10 +1,10 @@
\section{\class{wxSizer}}\label{wxsizer}
wxSizer is the abstract base class used for layouting subwindows in a window. You
wxSizer is the abstract base class used for laying out subwindows in a window. You
cannot use wxSizer directly; instead, you'll have to use \helpref{wxBoxSizer}{wxboxsizer}
or \helpref{wxStaticBoxSizer}{wxstaticboxsizer}.
The layouting algorithm used by sizers in wxWindows closely related to layouting
The layout algorithm used by sizers in wxWindows closely related to layout
in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is
based upon the idea of the individual subwindows reporting their minimal required
size and their ability to get stretched if the size of the parent window has changed.
@@ -27,7 +27,6 @@ on Windows, the intial dialog size will automatically be bigger on Motif than on
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxSizer::wxSizer}\label{wxsizerwxsizer}
\func{}{wxSizer}{\void}
@@ -85,8 +84,8 @@ the {\it option} flag - not in the main orientation, but the respectively other
if you created a wxBoxSizer with the wxVERTICAL option, these flags will be relevant if the
sizer changes its horizontal size. A child may get resized to completely fill out the new size (using
either wxGROW or wxEXPAND), may get centered (wxCENTER or wxCENTRE) or may get aligned to either
side (wxALIGN_LEFT and wxALIGN_TOP are set to 0 and thus represent the default, wxALIGN_RIGHT and
wxALIGN_BOTTOM have their obvious meaning.}
side (wxALIGN\_LEFT and wxALIGN\_TOP are set to 0 and thus represent the default, wxALIGN\_RIGHT and
wxALIGN\_BOTTOM have their obvious meaning.}
\docparam{border}{Determines the border width, if the {\it flag} parameter is set to any border.}
@@ -111,7 +110,7 @@ list of items (windows, subsizers or spaces) owned by this sizer.
Removes a child from the sizer. {\it window} is the window to be removed, {\it sizer} the
equivalent sizer and {\it nth} is the position of the child in the sizer, typically 0 for
the first item. This method does not cause any layouting or resizing to take place and does
the first item. This method does not cause any layout or resizing to take place and does
not delete the window itself. Call \helpref{wxSizer::Layout}{wxsizerlayout} for updating
the layout "on screen" after removing a child fom the sizer.
@@ -182,3 +181,4 @@ Tell the sizer to set the minimal size of the {\it window} to match the sizer's
This is commonly done in the constructor of the window itself, see sample in the description
of \helpref{wxBoxSizer}{wxboxsizer} if the window is resizable (as many dialogs under Unix and
frames on probably all platforms).

32
docs/latex/wx/socket.tex
View File

@@ -8,7 +8,7 @@
<wx/socket.h>
\wxheading{wxSocket errors}{wxsocketerrs}
\wxheading{wxSocket errors}%\label{wxsocketerrs} % Labels don't work on a non-section!
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
@@ -23,7 +23,7 @@
\twocolitem{{\bf wxSOCKET\_MEMERR}}{Memory exhausted.}
\end{twocollist}%
\wxheading{wxSocket events}{wxsocketevents}
\wxheading{wxSocket events}
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
@@ -120,12 +120,13 @@ For example:
In this example, the user will be notified about incoming socket datas and
a broken connection.
For more information on socket events see \helpref{wxSocket events}{wxsocketevents}.
For more information on socket events see \helpref{wxSocket events}{wxsocketbase}.
%
% SetTimeout
%
\membersection{wxSocketBase::SetTimeout}{wxsocketbasesettimeout}
\func{void}{SetTimeout}{\param{int }{seconds}}
This function sets the socket timeout in seconds.
@@ -191,7 +192,7 @@ Returns the number of bytes read or written by the last IO call.
\constfunc{wxSocketError}{LastError}{\void}
Returns the last occured wxSocket error. See \helpref{wxSocket errors}{wxsocketerrs}.
Returns the last occured wxSocket error. See \helpref{wxSocket errors}{wxsocketbase}.
% ---------------------------------------------------------------------------
% IO calls
@@ -501,7 +502,8 @@ Returns TRUE if a "lost" event occured, FALSE if the timeout was reached.
\func{void}{RestoreState}{\void}
This function restores a previously saved state.
This function restores the previous state of the socket (include flags,
notify flags, notify state, C callback function and data).
\wxheading{See also}
@@ -522,26 +524,13 @@ actually it saves all flags and the state of the asynchronous callbacks.
\wxheading{See also}
%
% SaveState
%
\helpref{wxSocketBase::RestoreState}{wxsocketbaserestorestate}
\membersection{wxSocketBase::RestoreState}\label{wxsocketbaserestorestate}
\func{void}{RestoreState}{\void}
This function restores the previous state of the socket (include flags,
notify flags, notify state, C callback function and data).
\wxheading{See also}
\helpref{wxSocketBase::SaveState}{wxsocketbasesavestate}
%
% GetLocal
%
\membersection{wxSocketBase::GetLocal}{wxsocketbasegetlocal}
\constfunc{bool}{GetLocal}{\param{wxSockAddress\& }{addr_man}}
This function returns the local address field of the socket. The local
@@ -556,6 +545,7 @@ It returns TRUE if no errors happened, FALSE otherwise.
% GetPeer
%
\membersection{wxSocketBase::GetPeer}{wxsocketbasegetlocal}
\constfunc{bool}{GetPeer}{\param{wxSockAddress\& }{addr_man}}
This function returns the peer address field of the socket. The peer
@@ -599,7 +589,7 @@ void SocketCallback(wxSocketBase& sock,wxSocketNotify evt,char *cdata);
\end{verbatim}
The first parameter reminds you of the caller socket. The second parameter
informs you about the current event (See \helpref{wxSocket events}{wxsocketevents}).
informs you about the current event (See \helpref{wxSocket events}{wxsocketbase}).
The third parameters is the client data you specified using \helpref{CallbackData}{wxsocketcallbackdata}.
\wxheading{Return value}
@@ -615,7 +605,7 @@ It returns the previous callback.
\func{char *}{CallbackData}{\param{char *}{cdata}}
This function sets the the client data which will be passed to a \helpref{C callback}{wxsocketcallback}.
This function sets the the client data which will be passed to a \helpref{C callback}{wxsocketbasecallback}.
\wxheading{Return value}

1
docs/latex/wx/treeevt.tex
View File

@@ -75,3 +75,4 @@ The key code if the event was is a key event.
\constfunc{const wxString&}{GetLabel}{}
Returns the label if the event was a begin or end edit label event.

49
docs/latex/wx/wxPython.tex
View File

@@ -14,8 +14,8 @@ wxPython is a blending of the wxWindows GUI classes and the
\wxheading{Python}
So what is Python? Go to
\urlref{http://www.python.org}{http://www.python.org}
to learn more, but in a nutshell Python is an interpreted,
\urlref{http://www.python.org}{http://www.python.org} to learn more,
but in a nutshell Python is an interpreted,
interactive, object-oriented programming language. It is often
compared to Tcl, Perl, Scheme or Java.
@@ -49,19 +49,18 @@ toolkit (wxGTK) on most Unix/X-windows platforms. The effort to
enable wxPython for wxMotif will begin shortly. See \helpref{Building Python}{wxpbuild} for
details about getting wxPython working for you.
%----------------------------------------------------------------------
\section{Why use wxPython?}\label{wxpwhy}
So why would you want to use wxPython over just C++ and wxWindows?
Personally I prefer using Python for everything. I only use C++ when
I absolutely have to eek more performance out of an algorithm, and even
I absolutely have to eke more performance out of an algorithm, and even
then I ususally code it as an extension module and leave the majority
of the program in Python.
Another good thing to use wxPython for is quick prototyping of your
wxWindows apps. With C++ you have to continuously go though the
edit-compile-link-run cycle, which can be quite time comsuming. With
edit-compile-link-run cycle, which can be quite time consuming. With
Python it is only an edit-run cycle. You can easily build an
application in a few hours with Python that would normally take a few
days or longer with C++. Converting a wxPython app to a C++/wxWindows app
@@ -79,7 +78,7 @@ on nearly every platform that Python and Tcl/TK are. Why Tcl/Tk?
Well because Tkinter is just a wrapper around Tcl's GUI toolkit, Tk.
This has its upsides and its downsides...
The upside is that Tk is a pretty veristile toolkit. It can be made
The upside is that Tk is a pretty versatile toolkit. It can be made
to do a lot of things in a lot of different environments. It is fairly
easy to create new widgets and use them interchangably in your
programs.
@@ -91,8 +90,8 @@ string processing, it is fairly slow as well. (Not too bad on a fast
Pentium II, but you really notice the difference on slower machines.)
It wasn't until the lastest version of Tcl/Tk that native Look and
Feel's were possible on non-Motif platforms. This is because Tk
usually implements it's own widgets (controls) even when there are
Feel was possible on non-Motif platforms. This is because Tk
usually implements its own widgets (controls) even when there are
native controls available.
Tkinter is a pretty low-level toolkit. You have to do a lot of work
@@ -102,7 +101,7 @@ level of abstraction.
\wxheading{PythonWin}
PythonWin is an add-on package for Python for the Win32 platform. It
includes wrappers for MFC as well as much of the win32 API. Because
includes wrappers for MFC as well as much of the Win32 API. Because
of its foundation, it is very familiar for programmers who have
experience with MFC and the Win32 API. It is obviously not compatible
with other platforms and toolkits. PythonWin is organized as separate
@@ -114,8 +113,7 @@ to use the GUI portions.
There are quite a few other GUI modules available for Python, some in
active use, some that havn't been updated for ages. Most are simple
wrappers around some C or C++ toolkit or another, and most are not
cross-platform compatible. See \urlref{this
link}{http://www.python.org/download/Contributed.html\#Graphics}
cross-platform compatible. See \urlref{this link}{http://www.python.org/download/Contributed.html\#Graphics}
for a listing of a few of them.
%----------------------------------------------------------------------
@@ -138,11 +136,11 @@ wxPython is organized as a Python package. This means that the
directory containing the results of the build process should be a
subdirectory of a directory on the \tt{PYTHONPATH}. (And preferably should
be named wxPython.) You can control where the build process will dump
wxPython by setting the \tt{TARGETDIR} variable for the build utility, (see
below.)
wxPython by setting the \tt{TARGETDIR} variable for the build utility (see
below).
\begin{enumerate}\itemsep=0pt
\item Build wxWindows as described in its BuildCVS.txt file. For *nix
\item Build wxWindows as described in its BuildCVS.txt file. For Unix
systems I run configure with these flags:
\begin{verbatim}
@@ -160,21 +158,17 @@ below.)
You can use whatever flags you want, but I know these work.
For Win32 systems I use Visual C++ 6.0, but 5.0 should work also. The
build utility currently does not support any other win32 compilers.
build utility currently does not support any other Win32 compilers.
\item At this point you may want to make an alias or symlink, script,
batch file, whatever on the PATH that invokes
\tt{\$(WXWIN)/utils/wxPython/distrib/build.py} to help simplify matters
somewhat. For example, on my win32 system I have a file named
batch file, whatever on the PATH that invokes \tt{\$(WXWIN)/utils/wxPython/distrib/build.py} to
help simplify matters somewhat. For example, on my Win32 system I have a file named
\tt{build}.bat in a directory on the PATH that contains:
\tt{python \%WXWIN/utils/wxPython/distrib/build.py \%1 \%2 \%3 \%4 \%5 \%6}
\item Change into the \tt{\$(WXWIN)/utils/wxPython/src} directory.
\item Type "\tt{build -b}" to build wxPython and "\tt{build -i}" to
install it, or \"\tt{build -bi}\" to do both steps at once.
install it, or "\tt{build -bi}" to do both steps at once.
The build.py script actually generates a Makefile based on what it
finds on your system and information found in the build.cfg file.
@@ -182,26 +176,19 @@ install it, or \"\tt{build -bi}\" to do both steps at once.
a different way, take a look at the docstring in build.py. You are
able to to override many configuration options in a file named
build.local.
\item To build and install the add-on modules, change to the appropriate
directory under \tt{\$(WXWIN)/utils/wxPython/modules} and run the build
utility again.
\item Change to the \tt{\$(WXWIN)/utils/wxPython/demo} directory.
\item Try executing the demo program. For example:
\tt{python demo.py}
To run it without requiring a console on win32, you can use the
To run it without requiring a console on Win32, you can use the
\tt{pythonw.exe} version of Python either from the command line or from a
shortcut.
\end{enumerate}
%----------------------------------------------------------------------
\section{Using wxPython}\label{wxpusing}
@@ -496,8 +483,6 @@ as possible to the C++ spec over time.
\item \helpref{wxUpdateUIEvent}{wxupdateuievent}
\item \helpref{wxWindowDC}{wxwindowdc}
\item \helpref{wxWindow}{wxwindow}
\end{itemize}
%----------------------------------------------------------------------