Added wxVariant documentation; updated wxWindow, wxScrollBar docs

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1082 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
1998-11-29 21:12:52 +00:00
parent 89b892a298
commit a974387a22
5 changed files with 482 additions and 9 deletions

View File

@@ -147,6 +147,8 @@ Clears the window by filling it with the current background colour.
\constfunc{virtual void}{ClientToScreen}{\param{int* }{x}, \param{int* }{y}}
\constfunc{virtual wxPoint}{ClientToScreen}{\param{const wxPoint\&}{ pt}}
Converts to screen coordinates from coordinates relative to this window.
\docparam{x}{A pointer to a integer value for the x coordinate. Pass the client coordinate in, and
@@ -155,6 +157,8 @@ a screen coordinate will be passed out.}
\docparam{y}{A pointer to a integer value for the y coordinate. Pass the client coordinate in, and
a screen coordinate will be passed out.}
\docparam{pt}{The client position for the second form of the function.}
\membersection{wxWindow::Close}\label{wxwindowclose}
\func{virtual bool}{Close}{\param{const bool}{ force = FALSE}}
@@ -383,6 +387,8 @@ Returns a pointer to the list of the window's children.
\constfunc{virtual void}{GetClientSize}{\param{int* }{width}, \param{int* }{height}}
\constfunc{virtual wxSize}{GetClientSize}{\void}
This gets the size of the window `client area' in pixels. The client area is the
area which may be drawn on by the programmer, excluding title bar, border etc.
@@ -527,6 +533,12 @@ name in the window constructor or via \helpref{wxWindow::SetName}{wxwindowsetnam
Returns the parent of the window, or NULL if there is no parent.
\membersection{wxWindow::GetRect}\label{wxwindowgetrect}
\constfunc{virtual wxRect}{GetRect}{\void}
Returns the size and position of the window as a \helpref{wxRect}{wxrect} object.
\membersection{wxWindow::GetReturnCode}\label{wxwindowgetreturncode}
\func{int}{GetReturnCode}{\void}
@@ -573,10 +585,12 @@ Returns the built-in scrollbar range.
\helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
\membersection{wxWindow::GetSize}
\membersection{wxWindow::GetSize}\label{wxwindowgetsize}
\constfunc{virtual void}{GetSize}{\param{int* }{width}, \param{int* }{height}}
\constfunc{virtual wxSize}{GetSize}{\void}
This gets the size of the entire window in pixels.
\wxheading{Parameters}
@@ -732,6 +746,8 @@ the user can only interact with this window. If FALSE, the effect is reversed.}
\func{void}{Move}{\param{int}{ x}, \param{int}{ y}}
\func{void}{Move}{\param{const wxPoint\&}{ pt}}
Moves the window to the given position.
\wxheading{Parameters}
@@ -740,6 +756,8 @@ Moves the window to the given position.
\docparam{y}{Required y position.}
\docparam{pt}{\helpref{wxPoint}{wxpoint} object representing the position.}
\wxheading{Remarks}
Implementations of SetSize can also implicitly implement the
@@ -1395,10 +1413,12 @@ functions so should not be required by the application programmer.
\docparam{child}{Child window to remove.}
\membersection{wxWindow::ScreenToClient}
\membersection{wxWindow::ScreenToClient}\label{wxwindowscreentoclient}
\constfunc{virtual void}{ScreenToClient}{\param{int* }{x}, \param{int* }{y}}
\constfunc{virtual wxPoint}{ScreenToClient}{\param{const wxPoint\& }{pt}}
Converts from screen to client window coordinates.
\wxheading{Parameters}
@@ -1407,6 +1427,8 @@ Converts from screen to client window coordinates.
\docparam{y}{Stores the screen x coordinate and receives the client x coordinate.}
\docparam{pt}{The screen position for the second form of the function.}
\membersection{wxWindow::ScrollWindow}\label{wxwindowscrollwindow}
\func{virtual void}{ScrollWindow}{\param{int }{dx}, \param{int }{dy}, \param{const wxRect*}{ rect = NULL}}
@@ -1742,10 +1764,14 @@ and usually the scrollbar will be automatically hidden.
\func{virtual void}{SetSize}{\param{int}{ x}, \param{int}{ y}, \param{int}{ width}, \param{int}{ height},
\param{int}{ sizeFlags = wxSIZE\_AUTO}}
\func{virtual void}{SetSize}{\param{const wxRect\&}{ rect}}
Sets the size and position of the window in pixels.
\func{virtual void}{SetSize}{\param{int}{ width}, \param{int}{ height}}
\func{virtual void}{SetSize}{\param{const wxSize\&}{ size}}
Sets the size of the window in pixels.
\wxheading{Parameters}
@@ -1762,6 +1788,10 @@ value should be used.}
\docparam{height}{Required height position in pixels, or -1 to indicate that the existing
value should be used.}
\docparam{size}{\helpref{wxSize}{wxsize} object for setting the size.}
\docparam{rect}{\helpref{wxRect}{wxrect} object for setting the position and size.}
\docparam{sizeFlags}{Indicates the interpretation of other parameters. It is a bit list of the following:
{\bf wxSIZE\_AUTO\_WIDTH}: a -1 width value is taken to indicate
@@ -1822,6 +1852,8 @@ The resizing increments are only significant under Motif or Xt.
\func{virtual void}{SetClientSize}{\param{int}{ width}, \param{int}{ height}}
\func{virtual void}{SetClientSize}{\param{const wxSize\&}{ size}}
This sets the size of the window client area in pixels. Using this function to size a window
tends to be more device-independent than \helpref{wxWindow::SetSize}{wxwindowsetsize}, since the application need not
worry about what dimensions the border or title bar have when trying to fit the window
@@ -1833,6 +1865,8 @@ around panel items, for example.
\docparam{height}{The required client area height.}
\docparam{size}{The required client size.}
\membersection{wxWindow::SetPalette}
\func{virtual void}{SetPalette}{\param{wxPalette* }{palette}}