Minor doc corrections

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@29288 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2004-09-23 19:36:28 +00:00
parent beb3c20c88
commit 01a01d1084
8 changed files with 11 additions and 14 deletions

View File

@@ -52,7 +52,7 @@ Default constructor.
\func{}{wxButton}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label = wxEmptyString},\rtfsp \func{}{wxButton}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label = wxEmptyString},\rtfsp
\param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}} \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``button"}}
Constructor, creating and showing a button. Constructor, creating and showing a button.

View File

@@ -25,7 +25,7 @@ application windows.
\twocolwidtha{5cm} \twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt \begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxRESIZE\_BORDER \pipe wxSYSTEM\_MENU \pipe wxCAPTION \pipe wxCLOSE\_BOX}.} \twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxRESIZE\_BORDER \pipe wxSYSTEM\_MENU \pipe wxCAPTION \pipe wxCLOSE\_BOX \pipe wxCLIP\_CHILDREN}.}
\twocolitem{\windowstyle{wxICONIZE}}{Display the frame iconized (minimized). Windows only. } \twocolitem{\windowstyle{wxICONIZE}}{Display the frame iconized (minimized). Windows only. }
\twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the frame.} \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the frame.}
\twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}. Windows only.} \twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}. Windows only.}

View File

@@ -3,8 +3,7 @@
A wxSpinButton has two small up and down (or left and right) arrow buttons. It A wxSpinButton has two small up and down (or left and right) arrow buttons. It
is often used next to a text control for increment and decrementing a value. is often used next to a text control for increment and decrementing a value.
Portable programs should try to use \helpref{wxSpinCtrl}{wxspinctrl} instead Portable programs should try to use \helpref{wxSpinCtrl}{wxspinctrl} instead
as wxSpinButton is not implemented for all platforms (Win32 and GTK only as wxSpinButton is not implemented for all platforms.
currently).
{\bf NB:} the range supported by this control (and wxSpinCtrl) depends on the {\bf NB:} the range supported by this control (and wxSpinCtrl) depends on the
platform but is at least {\tt -0x8000} to {\tt 0x7fff}. Under GTK and platform but is at least {\tt -0x8000} to {\tt 0x7fff}. Under GTK and
@@ -32,7 +31,7 @@ required, 5.80 is recommended) the full 32 bit range is supported.
\begin{twocollist}\itemsep=0pt \begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxSP\_HORIZONTAL}}{Specifies a horizontal spin button (note that this style is not supported in wxGTK).} \twocolitem{\windowstyle{wxSP\_HORIZONTAL}}{Specifies a horizontal spin button (note that this style is not supported in wxGTK).}
\twocolitem{\windowstyle{wxSP\_VERTICAL}}{Specifies a vertical spin button.} \twocolitem{\windowstyle{wxSP\_VERTICAL}}{Specifies a vertical spin button.}
\twocolitem{\windowstyle{wxSP\_ARROW\_KEYS}}{The user can use arrow keys.} \twocolitem{\windowstyle{wxSP\_ARROW\_KEYS}}{The user can use arrow keys to change the value.}
\twocolitem{\windowstyle{wxSP\_WRAP}}{The value wraps at the minimum and maximum.} \twocolitem{\windowstyle{wxSP\_WRAP}}{The value wraps at the minimum and maximum.}
\end{twocollist} \end{twocollist}

View File

@@ -23,7 +23,7 @@ wxSpinCtrl combines \helpref{wxTextCtrl}{wxtextctrl} and
\twocolwidtha{5cm} \twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt \begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxSP\_ARROW\_KEYS}}{The user can use arrow keys.} \twocolitem{\windowstyle{wxSP\_ARROW\_KEYS}}{The user can use arrow keys to change the value.}
\twocolitem{\windowstyle{wxSP\_WRAP}}{The value wraps at the minimum and maximum.} \twocolitem{\windowstyle{wxSP\_WRAP}}{The value wraps at the minimum and maximum.}
\end{twocollist} \end{twocollist}

View File

@@ -11,10 +11,7 @@ required.
A bitmap created dynamically or loaded from a file can be selected A bitmap created dynamically or loaded from a file can be selected
into a memory device context (instance of \helpref{wxMemoryDC}{wxmemorydc}). This into a memory device context (instance of \helpref{wxMemoryDC}{wxmemorydc}). This
enables the bitmap to be copied to a window or memory device context enables the bitmap to be copied to a window or memory device context
using \helpref{wxDC::Blit}{wxdcblit}, or to be used as a drawing surface. The {\bf using \helpref{wxDC::Blit}{wxdcblit}, or to be used as a drawing surface.
wxToolBarSimple} class is implemented using bitmaps, and the toolbar demo
shows one of the toolbar bitmaps being used for drawing a miniature
version of the graphic which appears on the main window.
See \helpref{wxMemoryDC}{wxmemorydc} for an example of drawing onto a bitmap. See \helpref{wxMemoryDC}{wxmemorydc} for an example of drawing onto a bitmap.

View File

@@ -280,11 +280,11 @@ streambuf\\
\twocolwidtha{5cm} \twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt \begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxTE\_PROCESS\_ENTER}}{The control will generate \twocolitem{\windowstyle{wxTE\_PROCESS\_ENTER}}{The control will generate
the message wxEVENT\_TYPE\_TEXT\_ENTER\_COMMAND (otherwise pressing Enter key the event wxEVT\_COMMAND\_TEXT\_ENTER (otherwise pressing Enter key
is either processed internally by the control or used for navigation between is either processed internally by the control or used for navigation between
dialog controls).} dialog controls).}
\twocolitem{\windowstyle{wxTE\_PROCESS\_TAB}}{The control will receive \twocolitem{\windowstyle{wxTE\_PROCESS\_TAB}}{The control will receive
EVT\_CHAR messages for TAB pressed - normally, TAB is used for passing to the wxEVT\_CHAR events for TAB pressed - normally, TAB is used for passing to the
next control in a dialog instead. For the control created with this style, next control in a dialog instead. For the control created with this style,
you can still use Ctrl-Enter to pass to the next control from the keyboard.} you can still use Ctrl-Enter to pass to the next control from the keyboard.}
\twocolitem{\windowstyle{wxTE\_MULTILINE}}{The text control allows multiple lines.} \twocolitem{\windowstyle{wxTE\_MULTILINE}}{The text control allows multiple lines.}

View File

@@ -75,6 +75,7 @@ functions that take a \helpref{wxTreeEvent}{wxtreeevent} argument.
\begin{twocollist}\itemsep=0pt \begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_TREE\_BEGIN\_DRAG(id, func)}}{Begin dragging with the left mouse button.} \twocolitem{{\bf EVT\_TREE\_BEGIN\_DRAG(id, func)}}{Begin dragging with the left mouse button.}
\twocolitem{{\bf EVT\_TREE\_BEGIN\_RDRAG(id, func)}}{Begin dragging with the right mouse button.} \twocolitem{{\bf EVT\_TREE\_BEGIN\_RDRAG(id, func)}}{Begin dragging with the right mouse button.}
\twocolitem{{\bf EVT\_TREE\_END\_DRAG(id, func)}}{End dragging with the left or right mouse button.}
\twocolitem{{\bf EVT\_TREE\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.} \twocolitem{{\bf EVT\_TREE\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
\twocolitem{{\bf EVT\_TREE\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.} \twocolitem{{\bf EVT\_TREE\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
\twocolitem{{\bf EVT\_TREE\_DELETE\_ITEM(id, func)}}{Delete an item.} \twocolitem{{\bf EVT\_TREE\_DELETE\_ITEM(id, func)}}{Delete an item.}

View File

@@ -32,7 +32,7 @@ appropriately for text, and calls \helpref{wxTextDropTarget::OnDropText}{wxtextd
\membersection{wxTextDropTarget::OnDropText}\label{wxtextdroptargetondroptext} \membersection{wxTextDropTarget::OnDropText}\label{wxtextdroptargetondroptext}
\func{virtual bool}{OnDropText}{\param{long }{x}, \param{long }{y}, \param{const char }{*data}} \func{virtual bool}{OnDropText}{\param{wxCoord }{x}, \param{wxCoord }{y}, \param{const wxString\&}{ data}}
Override this function to receive dropped text. Override this function to receive dropped text.
@@ -42,7 +42,7 @@ Override this function to receive dropped text.
\docparam{y}{The y coordinate of the mouse.} \docparam{y}{The y coordinate of the mouse.}
\docparam{data}{The data being dropped: a NULL-terminated string.} \docparam{data}{The data being dropped: a wxString.}
\wxheading{Return value} \wxheading{Return value}