AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Doc fixes N-Z edition. Thanks to Arnout for pointing these out. Also I fixed some others as I went along...

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31805 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Ryan Norton 2005-02-06 18:25:54 +00:00
parent f7204798e2
commit 9a75ba66de
29 changed files with 69 additions and 624 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -43,7 +43,6 @@ The following are a variety of classes that are derived from wxWindow.
\twocolitem{\helpref{wxNotebook}{wxnotebook}}{Notebook class}
\twocolitem{\helpref{wxListbook}{wxlistbook}}{Similar to notebook but using list control}
\twocolitem{\helpref{wxChoicebook}{wxchoicebook}}{Similar to notebook but using choice control}
\twocolitem{\helpref{wxPlotWindow}{wxplotwindow}}{A class to display data.}
\twocolitem{\helpref{wxSashWindow}{wxsashwindow}}{Window with four optional sashes that can be dragged}
\twocolitem{\helpref{wxSashLayoutWindow}{wxsashlayoutwindow}}{Window that can be involved in an IDE-like layout arrangement}
\twocolitem{\helpref{wxVScrolledWindow}{wxvscrolledwindow}}{As wxScrolledWindow but supports lines of variable height}

5
docs/latex/wx/classes.tex
View File

@ -242,13 +242,10 @@
\input passdlg.tex
\input pathlist.tex
\input pen.tex
\input plotcurve.tex
\input plotwindow.tex
\input point.tex
\input postscpt.tex
\input prevwin.tex
\input print.tex
\input prvtdrpt.tex
\input process.tex
\input procevt.tex
\input progdlg.tex
@ -286,7 +283,6 @@
\input sizer.tex
\input sizeritem.tex
\input slider.tex
\input sckaddr.tex
\input socket.tex
\input strmsock.tex
\input socksrv.tex
@ -337,7 +333,6 @@
\input valtext.tex
\input thread.tex
\input threadh.tex
\input threadht.tex
\input timer.tex
\input timespan.tex
\input tipprov.tex

2
docs/latex/wx/panel.tex
View File

@ -90,7 +90,7 @@ for details.
\membersection{wxPanel::GetDefaultItem}\label{wxpanelgetdefaultitem}
\constfunc{wxButton*}{GetDefaultItem}{\void}
\constfunc{wxWindow*}{GetDefaultItem}{\void}
Returns a pointer to the button which is the default for this window, or NULL.
The default button is the one activated by pressing the Enter key.

93
docs/latex/wx/plotcurve.tex
View File

@ -1,93 +0,0 @@
%
% automatically generated by HelpGen from
% plot.h at 11/Feb/00 18:00:57
%
\section{\class{wxPlotCurve}}\label{wxplotcurve}
The wxPlotCurve class represents a curve displayed in a \helpref{wxPlotWindow}{wxplotwindow}. It
is a virtual curve, i.e. is acts only as an interface, leaving it to the programmer to care for
how the values pairs are matched. wxPlotWindow and wxPlotCurve are designed to display large
amounts of data, i.e. most typically data measured by some sort of machine.
This class is abstract, i.e. you have to derive your own class and implement the pure
virtual functions (\helpref{GetStartX()}{wxplotcurvegetstartx}, \helpref{GetEndX()}{wxplotcurvegetendx}
and \helpref{GetY()}{wxplotcurvegety}).
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPlotCurve::wxPlotCurve}\label{wxplotcurvewxplotcurve}
\func{}{wxPlotCurve}{\param{int }{offsetY}, \param{double }{startY}, \param{double }{endY}}
Constructor assigning start values. See below for interpretation.
\membersection{wxPlotCurve::GetEndX}\label{wxplotcurvegetendx}
\func{wxInt32}{GetEndX}{\void}
Must be overridden. This function should return the index of the last value
of this curve, typically 99 if 100 values have been measured.
\membersection{wxPlotCurve::GetEndY}\label{wxplotcurvegetendy}
\func{double}{GetEndY}{\void}
See \helpref{SetStartY}{wxplotcurvesetendy}.
\membersection{wxPlotCurve::GetOffsetY}\label{wxplotcurvegetoffsety}
\func{int}{GetOffsetY}{\void}
Returns the vertical offset.
\membersection{wxPlotCurve::GetY}\label{wxplotcurvegety}
\func{double}{GetY}{\param{wxInt32 }{x}}
Must be overridden. This function will return the actual Y value corresponding
to the given X value. The x value is of an integer type because it is considered
to be an index in row of measured values.
\membersection{wxPlotCurve::GetStartX}\label{wxplotcurvegetstartx}
\func{wxInt32}{GetStartX}{\void}
Must be overridden. This function should return the index of the first value
of this curve, typically zero.
\membersection{wxPlotCurve::GetStartY}\label{wxplotcurvegetstarty}
\func{double}{GetStartY}{\void}
See \helpref{SetStartY}{wxplotcurvesetstarty}.
\membersection{wxPlotCurve::SetEndY}\label{wxplotcurvesetendy}
\func{void}{SetEndY}{\param{double }{endY}}
The value returned by this function tells the plot window what the highest values
in the curve will be so that a suitable scale can be found for the display. If
the Y values in this curve are in the range of -1.5 to 0.5, this function should
return 0.5 or maybe 1.0 for nicer aesthetics.
\membersection{wxPlotCurve::SetOffsetY}\label{wxplotcurvesetoffsety}
\func{void}{SetOffsetY}{\param{int }{offsetY}}
When displaying several curves in one window, it is often useful to assign
different offsets to the curves. You should call \helpref{wxPlotWindow::Move}{wxplotwindowmove}
to set this value after you have added the curve to the window.
\membersection{wxPlotCurve::SetStartY}\label{wxplotcurvesetstarty}
\func{void}{SetStartY}{\param{double }{startY}}
The value returned by this function tells the plot window what the lowest values
in the curve will be so that a suitable scale can be found for the display. If
the Y values in this curve are in the range of -1.5 to 0.5, this function should
return -1.5 or maybe -2.0 for nicer aesthetics.

176
docs/latex/wx/plotwindow.tex
View File

@ -1,176 +0,0 @@
%
% automatically generated by HelpGen from
% plot.h at 11/Feb/00 18:00:57
%
\section{\class{wxPlotWindow}}\label{wxplotwindow}
wxPlotWindow is a specialized window designed to display data that typically has
been measured by machines, i.e. that may have thousands of values. One example of
such data would be the well known ECG measuring the electrical activity of your
heart: the measuring device will produce thousands of values per minute, several
measurements are done simultaneously and you might want to have a look at parts
of the curves, enlarging them or scrolling from one position to another. Note
that this window is not useful for real-time measuring or for displaying charts
with error bars etc.
A single curve in the plot window is represented by the \helpref{wxPlotCurve}{wxplotcurve}
class.
The wxPlotWindow interacts with program using events, for example when clicking
or double clicking on a curve or when selecting one by clicking on it (which
can be vetoed). Future versions will hopefully feature selecting values or
sections of the displayed curves etc.
\wxheading{Derived from}
\helpref{wxScrolledWindow}{wxscrolledwindow}\\
\helpref{wxPanel}{wxpanel}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Window styles}
\begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxPLOT\_BUTTON\_MOVE}}{Display buttons to allow moving individual curves up or down.}
\twocolitem{\windowstyle{wxPLOT\_BUTTON\_ENLARGE}}{Display buttons to allow enlarging individual curves vertically.}
\twocolitem{\windowstyle{wxPLOT\_BUTTON\_ZOOM}}{Display buttons to allow zooming all curves horizontally.}
\twocolitem{\windowstyle{wxPLOT\_BUTTON\_ALL}}{Display all buttons.}
\twocolitem{\windowstyle{wxPLOT\_Y\_AXIS}}{Display an Y axis to the left of the drawing area.}
\twocolitem{\windowstyle{wxPLOT\_X\_AXIS}}{Display a X axis at the bottom of the drawing area.}
\twocolitem{\windowstyle{wxPLOT\_DEFAULT}}{All of the above options.}
\end{twocollist}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPlotWindow::wxPlotWindow}\label{wxplotwindowwxplotwindow}
\func{}{wxPlotWindow}{\void}
\func{}{wxPlotWindow}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size}, \param{int }{flags = wxPLOT\_DEFAULT}}
Constructor.
\membersection{wxPlotWindow::\destruct{wxPlotWindow}}\label{wxplotwindowdtor}
\func{}{\destruct{wxPlotWindow}}{\void}
The destructor will not delete the curves associated to the window.
\membersection{wxPlotWindow::Add}\label{wxplotwindowadd}
\func{void}{Add}{\param{wxPlotCurve* }{curve}}
Add a curve to the window.
\membersection{wxPlotWindow::GetCount}\label{wxplotwindowgetcount}
\func{size\_t}{GetCount}{\void}
Returns number of curves.
\membersection{wxPlotWindow::GetAt}\label{wxplotwindowgetat}
\func{wxPlotCurve*}{GetAt}{\param{size\_t }{n}}
Get the nth curve.
\membersection{wxPlotWindow::SetCurrentCurve}\label{wxplotwindowsetcurrentcurve}
\func{void}{SetCurrentCurve}{\param{wxPlotCurve* }{current}}
Make one curve the current curve. This will emit a wxPlotEvent.
\membersection{wxPlotWindow::GetCurrentCurve}\label{wxplotwindowgetcurrentcurve}
\func{wxPlotCurve*}{GetCurrentCurve}{\void}
Returns a pointer to the current curve, or NULL.
\membersection{wxPlotWindow::Delete}\label{wxplotwindowdelete}
\func{void}{Delete}{\param{wxPlotCurve* }{curve}}
Removes a curve from the window and delete is on screen. This does not
delete the actual curve. If the curve removed was the current curve,
the current curve will be set to NULL.
\membersection{wxPlotWindow::Move}\label{wxplotwindowmove}
\func{void}{Move}{\param{wxPlotCurve* }{curve}, \param{int }{pixels\_up}}
Move the curve {\tt curve} up by {\tt pixels\_up} pixels. Down if the
value is negative.
\membersection{wxPlotWindow::Enlarge}\label{wxplotwindowenlarge}
\func{void}{Enlarge}{\param{wxPlotCurve* }{curve}, \param{double }{factor}}
Changes the representation of the given curve. A {\tt factor} of more than
one will stretch the curve vertically. The Y axis will change accordingly.
\membersection{wxPlotWindow::SetUnitsPerValue}\label{wxplotwindowsetunitspervalue}
\func{void}{SetUnitsPerValue}{\param{double }{upv}}
This sets the virtual units per value. Normally, you will not be interested in
what measured value you see, but what it stands for. If you want to display seconds
on the X axis and the measuring device produced 50 values per second, set this
value to 50. This will affect all curves being displayed.
\membersection{wxPlotWindow::GetUnitsPerValue}\label{wxplotwindowgetunitspervalue}
\func{double}{GetUnitsPerValue}{\void}
See \helpref{SetUnitsPerValue}{wxplotwindowsetunitspervalue}.
\membersection{wxPlotWindow::SetZoom}\label{wxplotwindowsetzoom}
\func{void}{SetZoom}{\param{double }{zoom}}
This functions zooms all curves in their horizontal dimension. The X axis will
be changed accordingly.
\membersection{wxPlotWindow::GetZoom}\label{wxplotwindowgetzoom}
\func{double}{GetZoom}{\void}
See \helpref{SetZoom}{wxplotwindowsetzoom}.
\membersection{wxPlotWindow::RedrawEverything}\label{wxplotwindowredraweverything}
\func{void}{RedrawEverything}{\void}
Helper function which redraws both axes and the central area.
\membersection{wxPlotWindow::RedrawXAxis}\label{wxplotwindowredrawxaxis}
\func{void}{RedrawXAxis}{\void}
Helper function which redraws the X axis.
\membersection{wxPlotWindow::RedrawYAxis}\label{wxplotwindowredrawyaxis}
\func{void}{RedrawYAxis}{\void}
Helper function which redraws the Y axis.
\membersection{wxPlotWindow::SetScrollOnThumbRelease}\label{wxplotwindowsetscrollonthumbrelease}
\func{void}{SetScrollOnThumbRelease}{\param{bool}{ onrelease = true}}
This function controls if the plot area will get scrolled only if the scrollbar thumb
has been release or also if the thumb is being dragged. When displaying large amounts
of data, it might become impossible to display the data fast enough to produce smooth
scrolling and then this function should be called.
\membersection{wxPlotWindow::SetEnlargeAroundWindowCentre}\label{wxplotwindowsetenlargearoundwindowcentre}
\func{void}{SetEnlargeAroundWindowCentre}{\param{bool}{ aroundwindow = true}}
Depending on the kind of data you display, enlarging the individual curves might
have different desired effects. Sometimes, the data will be supposed to get enlarged
with the fixed point being the origin, sometimes the fixed point should be the centre
of the current drawing area. This function controls this behaviour.

45
docs/latex/wx/print.tex
View File

@ -413,15 +413,6 @@ is transferred to the application, so it must then be deleted
explicitly.
\membersection{wxPrintDialog::Ok}\label{wxprintdialogok}
\constfunc{bool}{Ok}{\void}
Returns true if the print data associated with the dialog is valid.
This can return false on Windows if the current printer is not set, for example.
On all other platforms, it returns true.
\membersection{wxPrintDialog::ShowModal}\label{wxprintdialogshowmodal}
\func{int}{ShowModal}{\void}
@ -702,19 +693,6 @@ dialog data, which will be copied to the printer object's local data.
\helpref{wxPrintData}{wxprintdata}
\membersection{wxPrinter::\destruct{wxPrinter}}\label{wxprinterdtor}
\func{}{\destruct{wxPrinter}}{\void}
Destructor.
\membersection{wxPrinter::Abort}\label{wxprinterabort}
\func{bool}{Abort}{\void}
Returns true if the user has aborted the print job.
\membersection{wxPrinter::CreateAbortWindow}\label{wxprintercreateabortwindow}
@ -723,6 +701,12 @@ Returns true if the user has aborted the print job.
Creates the default printing abort window, with a cancel button.
\membersection{wxPrinter::GetAbort}\label{wxprintergetabort}
\func{bool}{GetAbort}{\void}
Returns true if the user has aborted the print job.
\membersection{wxPrinter::GetLastError}\label{wxprintergetlasterror}
@ -1099,14 +1083,6 @@ Destructor. Deletes both print preview objects, so do not destroy these objects
in your application.
\membersection{wxPrintPreview::DrawBlankPage}\label{wxprintpreviewdrawblankpage}
\func{bool}{DrawBlankPage}{\param{wxWindow* }{window}}
Draws a representation of the blank page into the preview window. Used
internally.
\membersection{wxPrintPreview::GetCanvas}\label{wxprintpreviewgetcanvas}
\func{wxPreviewCanvas* }{GetCanvas}{\void}
@ -1143,13 +1119,6 @@ Returns the maximum page number.
Returns the minimum page number.
\membersection{wxPrintPreview::GetPrintData}\label{wxprintpreviewgetprintdata}
\func{wxPrintData\&}{GetPrintData}{\void}
Returns a reference to the internal print data.
\membersection{wxPrintPreview::GetPrintout}\label{wxprintpreviewgetprintout}
\func{wxPrintout *}{GetPrintout}{\void}
@ -1207,7 +1176,7 @@ Renders a page into a wxMemoryDC. Used internally by wxPrintPreview.
\membersection{wxPrintPreview::SetCanvas}\label{wxprintpreviewsetcanvas}
\func{void}{SetCanvas}{\param{wxPreviewCanvas** }{window}}
\func{void}{SetCanvas}{\param{wxPreviewCanvas* }{window}}
Sets the window to be used for displaying the print preview image.

35
docs/latex/wx/prvtdrpt.tex
View File

@ -1,35 +0,0 @@
\section{\class{wxPrivateDropTarget}}\label{wxprivatedroptarget}
wxPrivateDropTarget is for...
\wxheading{Derived from}
\helpref{wxDropTarget}{wxdroptarget}
\wxheading{Include files}
<wx/dnd.h>
\wxheading{See also}
\helpref{wxDropTarget}{wxdroptarget}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPrivateDropTarget::wxPrivateDropTarget}\label{wxprivatedroptargetwxprivatedroptarget}
\func{}{wxPrivateDropTarget}{\void}
\membersection{wxPrivateDropTarget::SetId}\label{wxprivatedroptargetsetid}
\func{void}{SetId}{\param{const wxString\& }{id}}
You have to override OnDrop to get at the data.
The string ID identifies the format of clipboard or DnD data. A word
processor would e.g. add a wxTextDataObject and a wxPrivateDataObject
to the clipboard - the latter with the Id "WXWORD\_FORMAT".
\membersection{wxPrivateDropTarget::GetId}\label{wxprivatedroptargetgetid}
\constfunc{virtual wxString}{GetId}{\void}

7
docs/latex/wx/radiobox.tex
View File

@ -176,10 +176,6 @@ Returns the number of items in the radiobox.
Returns the radiobox label.
\constfunc{wxString}{GetLabel}{\param{int }{n}}
Returns the label for the given button.
\wxheading{Parameters}
\docparam{n}{The zero-based button index.}
@ -237,9 +233,6 @@ Returns the number of buttons in the radiobox.
Sets the radiobox label.
\func{void}{SetLabel}{\param{int }{n}, \param{const wxString\&}{ label}}
Sets a label for a radio button.
\wxheading{Parameters}

2
docs/latex/wx/region.tex
View File

@ -104,7 +104,7 @@ being inside the region.
\membersection{wxRegion::GetBox}\label{wxregiongetbox}
\constfunc{void}{GetBox}{\param{long\& }{x}, \param{long\& }{y}, \param{long\& }{width}, \param{long\& }{height}}
\constfunc{void}{GetBox}{\param{wxCoord\& }{x}, \param{wxCoord\& }{y}, \param{wxCoord\& }{width}, \param{wxCoord\& }{height}}
Returns the outer bounds of the region.

31
docs/latex/wx/sashlayw.tex
View File

@ -46,7 +46,7 @@ about the layout events.
Default constructor.
\func{}{wxSashLayoutWindow}{\param{wxSashLayoutWindow*}{ parent}, \param{wxSashLayoutWindowID }{id},
\func{}{wxSashLayoutWindow}{\param{wxSashLayoutWindow*}{ parent}, \param{wxWindowID }{id},
\param{const wxPoint\& }{pos = wxDefaultPosition},
\param{const wxSize\& }{size = wxDefaultSize},
\param{long }{style = wxCLIP\_CHILDREN \pipe wxSW\_3D},
@ -71,11 +71,34 @@ should generate a default size for the window.}
\docparam{name}{Window name.}
\membersection{wxSashLayoutWindow::\destruct{wxSashLayoutWindow}}\label{wxsashlayoutwindowdtor}
\func{}{\destruct{wxSashLayoutWindow}}{\void}
\membersection{wxSashLayoutWindow::Create}\label{wxsashlayoutwindowcreate}
\func{bool}{Create}{\param{wxSashLayoutWindow*}{ parent}, \param{wxWindowID }{id},
\param{const wxPoint\& }{pos = wxDefaultPosition},
\param{const wxSize\& }{size = wxDefaultSize},
\param{long }{style = wxCLIP\_CHILDREN \pipe wxSW\_3D},
\param{const wxString\& }{name = "layoutWindow"}}
Initializes a sash layout window, which can be a child of a frame, dialog or any other non-control window.
\wxheading{Parameters}
\docparam{parent}{Pointer to a parent window.}
\docparam{id}{Window identifier. If -1, will automatically create an identifier.}
\docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxSashLayoutWindows
should generate a default position for the window. If using the wxSashLayoutWindow class directly, supply
an actual position.}
\docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxSashLayoutWindows
should generate a default size for the window.}
\docparam{style}{Window style. For window styles, please see \helpref{wxSashLayoutWindow}{wxsashlayoutwindow}.}
\docparam{name}{Window name.}
Destructor.
\membersection{wxSashLayoutWindow::GetAlignment}\label{wxsashlayoutwindowgetalignment}

2
docs/latex/wx/sashwin.tex
View File

@ -131,7 +131,7 @@ Gets the minimum window size in the x direction.
\membersection{wxSashWindow::GetMinimumSizeY}\label{wxsashwindowgetminimumsizey}
\constfunc{int}{GetMinimumSizeY}{\param{int}{ min}}
\constfunc{int}{GetMinimumSizeY}{\void}
Gets the minimum window size in the y direction.

59
docs/latex/wx/sckaddr.tex
View File

@ -1,59 +0,0 @@
% ----------------------------------------------------------------------------
% CLASS: wxSockAddress
% ----------------------------------------------------------------------------
\section{\class{wxSockAddress}}\label{wxsockaddress}
You are unlikely to need to use this class: only wxSocketBase uses it.
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/socket.h>
\wxheading{See also}
\helpref{wxSocketBase}{wxsocketbase}
\helpref{wxIPaddress}{wxipaddress}
\helpref{wxIPV4address}{wxipv4address}
% ----------------------------------------------------------------------------
% Members
% ----------------------------------------------------------------------------
\latexignore{\rtfignore{\wxheading{Members}}}
%
% ctor/dtor
%
\membersection{wxSockAddress::wxSockAddress}\label{wxsockaddressctor}
\func{}{wxSockAddress}{\void}
Default constructor.
\membersection{wxSockAddress::\destruct{wxSockAddress}}\label{wxsockaddressdtor}
\func{}{\destruct{wxSockAddress}}{\void}
Default destructor.
%
% Clear
%
\membersection{wxSockAddress::Clear}\label{wxsockaddressclear}
\func{void}{Clear}{\void}
Delete all informations about the address.
%
% SockAddrLen
%
\membersection{wxSockAddress::SockAddrLen}\label{wxsockaddresssockaddrlen}
\func{int}{SockAddrLen}{\void}
Returns the length of the socket address.

2
docs/latex/wx/scrlwevt.tex
View File

@ -40,7 +40,7 @@ sent as the user drags the thumbtrack).}
\membersection{wxScrollWinEvent::wxScrollWinEvent}\label{wxscrollwineventctor}
\func{}{wxScrollWinEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}, \param{int}{ pos = 0},
\func{}{wxScrollWinEvent}{\param{WXTYPE }{commandType = 0}, \param{int}{ pos = 0},
\rtfsp\param{int}{ orientation = 0}}
Constructor.

4
docs/latex/wx/size.tex
View File

@ -39,7 +39,7 @@ Creates a size object.
\membersection{wxSize::DecTo}\label{wxsizedecto}
\func{wxSize\&}{DecTo}{\param{const wxSize\& }{size}}
\func{void}{DecTo}{\param{const wxSize\& }{size}}
Decrements this object so that both of its dimensions are not greater than the
corresponding dimensions of the \arg{size}.
@ -78,7 +78,7 @@ Gets the height member.
\membersection{wxSize::IncTo}\label{wxsizeincto}
\func{wxSize\&}{IncTo}{\param{const wxSize\& }{size}}
\func{void}{IncTo}{\param{const wxSize\& }{size}}
Increments this object so that both of its dimensions are not less than the
corresponding dimensions of the \arg{size}.

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

@ -453,7 +453,7 @@ This is where wxSizerFlags comes in. Instead of a bunch of flags and other stuf
Note that by specification, all methods of wxSizerFlags return the wxSizerFlags object itself to ease the calling of multiple methods at a time.
\membersection{wxSizerFlags::wxSizer}\label{wxsizerflagsctor}
\membersection{wxSizerFlags::wxSizerFlags}\label{wxsizerflagsctor}
\func{}{wxSizerFlags}{\param{int }{proportion = 0}}

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

@ -173,14 +173,6 @@ Functions that allow applications to receive socket events.
\helpref{SetClientData}{wxsocketbasesetclientdata}\\
\helpref{SetEventHandler}{wxsocketbaseseteventhandler}
Callback functions are also available, but they are provided for backwards
compatibility only. Their use is strongly discouraged in favour of events,
and should be considered deprecated. Callbacks may be unsupported in future
releases of wxWidgets.
\helpref{Callback}{wxsocketbasecallback}\\
\helpref{CallbackData}{wxsocketbasecallbackdata}
% ---------------------------------------------------------------------------
% Members here
@ -208,67 +200,6 @@ Destructor. Do not destroy a socket using the delete operator directly;
use \helpref{Destroy}{wxsocketbasedestroy} instead. Also, do not create
socket objects in the stack.
%
% Callback
%
\membersection{wxSocketBase::Callback}\label{wxsocketbasecallback}
\func{wxSocketBase::wxSockCbk}{Callback}{\param{wxSocketBase::wxSockCbk}{ callback}}
You can setup a callback function to be called when an event occurs.
The function will be called only for those events for which notification
has been enabled with \helpref{Notify}{wxsocketbasenotify} and
\helpref{SetNotify}{wxsocketbasesetnotify}. The prototype of the
callback must be as follows:
\begin{verbatim}
void SocketCallback(wxSocketBase& sock, wxSocketNotify evt, char *cdata);
\end{verbatim}
The first parameter is a reference to the socket object in which the
event occurred. The second parameter tells you which event occurred.
(See \helpref{wxSocket events}{wxsocketbase}). The third parameter
is the user data you specified using \helpref{CallbackData}{wxsocketbasecallbackdata}.
\wxheading{Return value}
A pointer to the previous callback.
\wxheading{Remark/Warning}
Note that callbacks are now deprecated and unsupported, and they remain
for backwards compatibility only. Use events instead.
\wxheading{See also}
\helpref{wxSocketBase::CallbackData}{wxsocketbasecallbackdata},
\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify}
%
% CallbackData
%
\membersection{wxSocketBase::CallbackData}\label{wxsocketbasecallbackdata}
\func{char *}{CallbackData}{\param{char *}{cdata}}
This function sets the the user data which will be passed to a
callback function set via \helpref{Callback}{wxsocketbasecallback}.
\wxheading{Return value}
A pointer to the previous user data.
\wxheading{Remark/Warning}
Note that callbacks are now deprecated and unsupported, and they remain
for backwards compatibility only. Use events instead.
\wxheading{See also}
\helpref{wxSocketBase::Callback}{wxsocketbasecallback},
\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify}
%
% Close
@ -530,9 +461,7 @@ This function saves the current state of the socket in a stack. Socket
state includes flags, as set with \helpref{SetFlags}{wxsocketbasesetflags},
event mask, as set with \helpref{SetNotify}{wxsocketbasesetnotify} and
\helpref{Notify}{wxsocketbasenotify}, user data, as set with
\helpref{SetClientData}{wxsocketbasesetclientdata}, and asynchronous
callback settings, as set with \helpref{Callback}{wxsocketbasecallback}
and \helpref{CallbackData}{wxsocketbasecallbackdata}.
\helpref{SetClientData}{wxsocketbasesetclientdata}.
Calls to SaveState and RestoreState can be nested.

2
docs/latex/wx/splitter.tex
View File

@ -114,7 +114,7 @@ Destroys the wxSplitterWindow and its children.
\membersection{wxSplitterWindow::Create}\label{wxsplitterwindowcreate}
\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{int }{x},\rtfsp
\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \rtfsp
\param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{long }{style=wxSP\_3D}, \param{const wxString\&}{ name = "splitterWindow"}}

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

@ -226,19 +226,19 @@ The created IO buffer is growable by the object.
\membersection{wxStreamBuffer::GetBufferStart}\label{wxstreambuffergetbufferstart}
\constfunc{char *}{GetBufferStart}{\void}
\constfunc{void *}{GetBufferStart}{\void}
Returns a pointer on the start of the stream buffer.
\membersection{wxStreamBuffer::GetBufferEnd}\label{wxstreambuffergetbufferend}
\constfunc{char *}{GetBufferEnd}{\void}
\constfunc{void *}{GetBufferEnd}{\void}
Returns a pointer on the end of the stream buffer.
\membersection{wxStreamBuffer::GetBufferPos}\label{wxstreambuffergetbufferpos}
\constfunc{char *}{GetBufferPos}{\void}
\constfunc{void *}{GetBufferPos}{\void}
Returns a pointer on the current position of the stream buffer.

2
docs/latex/wx/strlist.tex
View File

@ -30,7 +30,7 @@ member.
Constructor.
\func{void}{wxStringList}{\param{char* }{first}, ...}
\func{}{wxStringList}{\param{char* }{first}, ...}
Constructor, taking NULL-terminated string argument list. wxStringList
allocates memory for the strings.

2
docs/latex/wx/strmbase.tex
View File

@ -85,7 +85,7 @@ In that cases, GetSize returns $0$ so you should always test its return value.
\membersection{wxStreamBase::IsOk}\label{wxstreambaseisok}
\constfunc{wxStreamError}{IsOk}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if no error occurred on the stream.

2
docs/latex/wx/strmsock.tex
View File

@ -64,7 +64,7 @@ and it does not support seeking.
\membersection{wxSocketOutputStream::wxSocketOutputStream}\label{wxsocketoutputstreamctor}
\func{}{wxSocketInputStream}{\param{wxSocketBase\&}{ s}}
\func{}{wxSocketOutputStream}{\param{wxSocketBase\&}{ s}}
Creates a new write-only socket stream using the specified initialized
socket connection.

4
docs/latex/wx/sysclevt.tex
View File

@ -37,9 +37,9 @@ or to pass the event on to the window's children explicitly.
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxSysColourChangedEvent::wxSysColourChanged}\label{wxsyscolourchangedctor}
\membersection{wxSysColourChangedEvent::wxSysColourChangedEvent}\label{wxsyscolourchangedeventctor}
\func{}{wxSysColourChanged}{\void}
\func{}{wxSysColourChangedEvent}{\void}
Constructor.

75
docs/latex/wx/threadht.tex
View File

@ -1,75 +0,0 @@
\section{\class{wxThreadHelperThread}}\label{wxThreadHelperThread}
The wxThreadHelperThread class is used internally by the
\helpref{wxThreadHelper}{wxthreadhelper} mix-in class. This class simply
calls \helpref{wxThreadHelper::Entry}{wxthreadhelperentry} in its owner class
when the thread runs.
\wxheading{Derived from}
\helpref{wxThread}{wxthread}
\wxheading{Include files}
<wx/thread.h>
\wxheading{See also}
\helpref{wxThread}{wxthread}, \helpref{wxThreadHelper}{wxthreadhelper}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxThreadHelperThread::wxThreadHelperThread}\label{wxthreadhelperthreadctor}
\func{}{wxThreadHelperThread}{\void}
This constructor simply initializes member variables.
\membersection{wxThreadHelperThread::m\_owner}\label{wxthreadhelperthreadmowner}
\member{wxThreadHelperThread\& }{m\_owner}
the \helpref{wxThreadHelper}{wxthreadhelper} object which holds the code to
run inside the thread.
\membersection{wxThreadHelperThread::Entry}\label{wxthreadhelperthreadentry}
\func{virtual ExitCode}{Entry}{\void}
This is the entry point of the thread. This function eventually calls
\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}. The actual worker
thread code should be implemented in
\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}, not here, so all
shared data and synchronization objects can be shared easily between the
main thread and the worker thread.
The returned value is the thread exit code which is the value returned by
\helpref{Wait()}{wxthreadwait}.
This function is called by wxWidgets itself and should never be called
directly.
\membersection{wxThreadHelperThread::CallEntry}\label{wxthreadhelperthreadcallentry}
\func{virtual ExitCode}{CallEntry}{\void}
This is a convenience method that actually calls
\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}. This function
eventually calls \helpref{wxThreadHelper::Entry}{wxthreadhelperentry}.
The actual worker thread code should be implemented in
\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}, not here, so all
shared data and synchronization objects can be shared easily between the
main thread and the worker thread.
It must be declared after \helpref{wxThreadHelper}{wxthreadhelper} so it
can access \helpref{wxThreadHelper::Entry}{wxthreadhelperentry} and avoid
circular dependencies. Thus, it uses the inline keyword to allow its
definition outside of the class definition. To avoid any conflicts
between the virtual and inline keywords, it is a non-virtual method.
The returned value is the thread exit code which is the value returned by
\helpref{Wait()}{wxthreadwait}.
This function is called by wxWidgets itself and should never be called
directly.

26
docs/latex/wx/toolbar.tex
View File

@ -186,13 +186,13 @@ Adds a separator for spacing groups of tools.
\membersection{wxToolBar::AddTool}\label{wxtoolbaraddtool}
\func{wxToolBarTool*}{AddTool}{\param{int}{ toolId},\rtfsp
\func{wxToolBarToolBase*}{AddTool}{\param{int}{ toolId},\rtfsp
\param{const wxString\&}{ label},\rtfsp
\param{const wxBitmap\&}{ bitmap1},\rtfsp
\param{const wxString\& }{shortHelpString = ""},\rtfsp
\param{wxItemKind}{ kind = wxITEM\_NORMAL}}
\func{wxToolBarTool*}{AddTool}{\param{int}{ toolId},\rtfsp
\func{wxToolBarToolBase*}{AddTool}{\param{int}{ toolId},\rtfsp
\param{const wxString\&}{ label},\rtfsp
\param{const wxBitmap\&}{ bitmap1},\rtfsp
\param{const wxBitmap\&}{ bitmap2 = wxNullBitmap},\rtfsp
@ -201,7 +201,7 @@ Adds a separator for spacing groups of tools.
\param{const wxString\& }{longHelpString = ""},\rtfsp
\param{wxObject* }{clientData = NULL}}
\func{wxToolBarTool*}{AddTool}{\param{wxToolBarTool* }{tool}}
\func{wxToolBarToolBase*}{AddTool}{\param{wxToolBarToolBase* }{tool}}
Adds a tool to the toolbar. The first (short and most commonly used) version
has fewer parameters than the full version at the price of not being able to
@ -253,7 +253,7 @@ order to have the tools appear.
\membersection{wxToolBar::AddCheckTool}\label{wxtoolbaraddchecktool}
\func{wxToolBarTool*}{AddCheckTool}{\param{int}{ toolId},\rtfsp
\func{wxToolBarToolBase*}{AddCheckTool}{\param{int}{ toolId},\rtfsp
\param{const wxString\&}{ label},\rtfsp
\param{const wxBitmap\&}{ bitmap1},\rtfsp
\param{const wxBitmap\&}{ bitmap2},\rtfsp
@ -270,7 +270,7 @@ as in \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.
\membersection{wxToolBar::AddRadioTool}\label{wxtoolbaraddradiotool}
\func{wxToolBarTool*}{AddRadioTool}{\param{int}{ toolId},\rtfsp
\func{wxToolBarToolBase*}{AddRadioTool}{\param{int}{ toolId},\rtfsp
\param{const wxString\&}{ label},\rtfsp
\param{const wxBitmap\&}{ bitmap1},\rtfsp
\param{const wxBitmap\&}{ bitmap2},\rtfsp
@ -342,7 +342,7 @@ will change the visible state of the tool to indicate that it is disabled.
\membersection{wxToolBar::FindById}\label{wxtoolbarfindbyid}
\func{wxToolBarTool*}{FindById}{\param{int }{id}}
\func{wxToolBarToolBase*}{FindById}{\param{int }{id}}
Returns a pointer to the tool identified by {\it id} or
NULL if no corresponding tool is found.
@ -356,7 +356,7 @@ NULL if no corresponding control is found.
\membersection{wxToolBar::FindToolForPosition}\label{wxtoolbarfindtoolforposition}
\constfunc{wxToolBarTool*}{FindToolForPosition}{\param{const float}{ x}, \param{const float}{ y}}
\constfunc{wxToolBarToolBase*}{FindToolForPosition}{\param{const float}{ x}, \param{const float}{ y}}
Finds a tool for the given mouse position.
@ -520,7 +520,7 @@ true if the tool is toggled on, false otherwise.
\membersection{wxToolBar::InsertControl}\label{wxtoolbarinsertcontrol}
\func{wxToolBarTool *}{InsertControl}{\param{size\_t }{pos}, \param{wxControl *}{control}}
\func{wxToolBarToolBase *}{InsertControl}{\param{size\_t }{pos}, \param{wxControl *}{control}}
Inserts the control into the toolbar at the given position.
@ -533,7 +533,7 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
\membersection{wxToolBar::InsertSeparator}\label{wxtoolbarinsertseparator}
\func{wxToolBarTool *}{InsertSeparator}{\param{size\_t }{pos}}
\func{wxToolBarToolBase *}{InsertSeparator}{\param{size\_t }{pos}}
Inserts the separator into the toolbar at the given position.
@ -546,13 +546,13 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
\membersection{wxToolBar::InsertTool}\label{wxtoolbarinserttool}
\func{wxToolBarTool *}{InsertTool}{\param{size\_t }{pos},\rtfsp
\func{wxToolBarToolBase *}{InsertTool}{\param{size\_t }{pos},\rtfsp
\param{int}{ toolId}, \param{const wxBitmap\&}{ bitmap1},\rtfsp
\param{const wxBitmap\&}{ bitmap2 = wxNullBitmap}, \param{bool}{ isToggle = false},\rtfsp
\param{wxObject* }{clientData = NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}}
\func{wxToolBarTool *}{InsertTool}{\param{size\_t }{pos},\rtfsp
\param{wxToolBarTool* }{tool}}
\func{wxToolBarToolBase *}{InsertTool}{\param{size\_t }{pos},\rtfsp
\param{wxToolBarToolBase* }{tool}}
Inserts the tool with the specified attributes into the toolbar at the given
position.
@ -648,7 +648,7 @@ This function should be called after you have added tools.
\membersection{wxToolBar::RemoveTool}\label{wxtoolbarremovetool}
\func{wxToolBarTool *}{RemoveTool}{\param{int }{id}}
\func{wxToolBarToolBase *}{RemoveTool}{\param{int }{id}}
Removes the given tool from the toolbar but doesn't delete it. This allows to
insert/add this tool back to this (or another) toolbar later.

2
docs/latex/wx/upduievt.tex
View File

@ -188,7 +188,7 @@ idle processing.
\membersection{wxUpdateUIEvent::SetMode}\label{wxupdateuieventsetmode}
\func{static void}{SetMode}{\param{wxIdleMode }{mode}}
\func{static void}{SetMode}{\param{wxUpdateUIMode }{mode}}
Specify how wxWidgets will send update events: to
all windows, or only to those which specify that they

2
docs/latex/wx/view.tex
View File

@ -83,7 +83,7 @@ Gets a pointer to the document associated with the view.
\membersection{wxView::GetDocumentManager}\label{wxviewgetdocumentmanager}
\constfunc{wxDocumentManager*}{GetDocumentManager}{\void}
\constfunc{wxDocManager*}{GetDocumentManager}{\void}
Returns a pointer to the document manager instance associated with this view.

2
docs/latex/wx/window.tex
View File

@ -2671,7 +2671,7 @@ by the children of this window.
\membersection{wxWindow::SetOwnFont}\label{wxwindowsetownfont}
\func{void}{SetOwnBackgroundColour}{\param{const wxColour\& }{colour}}
\func{void}{SetOwnFont}{\param{const wxFont\& }{font}}
Sets the font of the window but prevents it from being inherited by the
children of this window.

2
docs/latex/wx/wxstring.tex
View File

@ -1338,7 +1338,7 @@ None
\membersection{wxStringBufferLength::wxStringBufferLength}\label{wxstringbufferlengthctor}
\func{}{wxStringBuffer}{\param{const wxString\& }{str}, \param{size\_t }{len}}
\func{}{wxStringBufferLength}{\param{const wxString\& }{str}, \param{size\_t }{len}}
Constructs a writable string buffer object associated with the given string
and containing enough space for at least {\it len} characters. Basically, this

27
docs/latex/wx/xmlres.tex
View File

@ -88,24 +88,6 @@ Removes all handlers.
Compares the XRC version to the argument. Returns -1 if the XRC version
is less than the argument, +1 if greater, and 0 if they equal.
\membersection{wxXmlResource::CreateResFromNode}\label{wxxmlresourcecreateresfromnode}
\func{wxObject*}{CreateResFromNode}{\param{wxXmlNode* }{node}, \param{wxObject* }{parent}, \param{wxObject* }{instance = NULL}}
Creates a resource from information in the given node.
\membersection{wxXmlResource::DoFindResource}\label{wxxmlresourcedofindresource}
\func{wxXmlNode*}{DoFindResource}{\param{wxXmlNode* }{parent}, \param{const wxString\& }{name}, \param{const wxString\& }{classname}, \param{bool }{recursive}}
Helper function: finds a resource (calls UpdateResources) and returns a node containing it.
\membersection{wxXmlResource::FindResource}\label{wxxmlresourcefindresource}
\func{wxXmlNode*}{FindResource}{\param{const wxString\& }{name}, \param{const wxString\& }{classname}, \param{bool }{recursive = false}}
Finds a resource (calls UpdateResources) and returns a node containing it.
\membersection{wxXmlResource::Get}\label{wxxmlresourceget}
\func{wxXmlResource*}{Get}{\void}
@ -227,14 +209,7 @@ Sets the global resources object and returns a pointer to the previous one (may
\membersection{wxXmlResource::SetFlags}\label{wxxmlresourcesetflags}
\func{int}{SetFlags}{\void}
\func{void}{SetFlags}{\param{int }{flags}}
Sets flags (bitlist of wxXRC\_USE\_LOCALE and wxXRC\_NO\_SUBCLASSING).
\membersection{wxXmlResource::UpdateResources}\label{wxxmlresourceupdateresources}
\func{void}{UpdateResources}{\void}
Scans the resources list for unloaded files and loads them. Also reloads
files that have been modified since the last load.