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

This commit was manufactured by cvs2svn to create tag 'WX_2_2_9'.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/tags/WX_2_2_9@13364 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2002-01-04 16:15:08 +00:00
parent dc3d889d0b
commit f7f6abe24d
2324 changed files with 375095 additions and 121526 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -42,9 +42,9 @@ the application-wide policy is for 3D controls. Windows only.}
wants to get all char events - even for keys like TAB or ENTER which are
usually used for dialog navigation and which wouldn't be generated without
this style}
\twocolitem{\windowstyle{wxNO\_FULLREPAINT\_ON\_RESIZE}}{Disables repainting
\twocolitem{\windowstyle{wxNO\_FULL\_REPAINT\_ON\_RESIZE}}{Disables repainting
the window completely when its size is changed - you will have to repaint the
new window area manually if you use style. Currently only has effect for
new window area manually if you use this style. Currently only has an effect for
Windows.}
\twocolitem{\windowstyle{wxVSCROLL}}{Use this style to enable a vertical scrollbar. (Still used?) }
\twocolitem{\windowstyle{wxHSCROLL}}{Use this style to enable a horizontal scrollbar. (Still used?) }
@@ -60,7 +60,7 @@ See also \helpref{window styles overview}{windowstyles}.
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxWindow::wxWindow}
\membersection{wxWindow::wxWindow}\label{wxwindowctor}
\func{}{wxWindow}{\void}
@@ -178,7 +178,7 @@ centered relative to the screen anyhow.
\func{void}{CentreOnParent}{\param{int}{ direction = wxBOTH}}
Centres the window on its parent. This is a more readable synonym for
Centres the window on its parent. This is a more readable synonym for
\helpref{Centre}{wxwindowcentre}.
\wxheading{Parameters}
@@ -190,7 +190,7 @@ or {\tt wxBOTH}.}
This methods provides for a way to center top level windows over their
parents instead of the entire screen. If there is no parent or if the
window is not a top level window, then behaviour is the same as
window is not a top level window, then behaviour is the same as
\helpref{wxWindow::Centre}{wxwindowcentre}.
\wxheading{See also}
@@ -481,6 +481,12 @@ control label is not truncated. For windows containing subwindows (typically
same as the size the window would have had after calling
\helpref{Fit}{wxwindowfit}.
\membersection{wxWindow::GetCaret}\label{wxwindowgetcaret}
\constfunc{wxCaret *}{GetCaret}{\void}
Returns the \helpref{caret}{wxcaret} associated with the window.
\membersection{wxWindow::GetCharHeight}
\constfunc{virtual int}{GetCharHeight}{\void}
@@ -517,8 +523,8 @@ area which may be drawn on by the programmer, excluding title bar, border etc.
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
\twocolitem{{\bf wxGetClientSizeTuple()}}{Returns a 2-tuple of (width, height)}
\twocolitem{{\bf wxGetClientSize()}}{Returns a wxSize object}
\twocolitem{{\bf GetClientSizeTuple()}}{Returns a 2-tuple of (width, height)}
\twocolitem{{\bf GetClientSize()}}{Returns a wxSize object}
\end{twocollist}}
}
@@ -536,7 +542,7 @@ Returns the associated drop target, which may be NULL.
\wxheading{See also}
\helpref{wxWindow::SetDropTarget}{wxwindowsetdroptarget},
\helpref{wxWindow::SetDropTarget}{wxwindowsetdroptarget},
\helpref{Drag and drop overview}{wxdndoverview}
\membersection{wxWindow::GetEventHandler}\label{wxwindowgeteventhandler}
@@ -634,27 +640,6 @@ the button text. This function can be useful for meta-programs (such as testing
tools or special-needs access programs) which need to identify windows
by name.
\membersection{wxWindow::GetPosition}
\constfunc{virtual void}{GetPosition}{\param{int* }{x}, \param{int* }{y}}
This gets the position of the window in pixels, relative to the parent window or
if no parent, relative to the whole display.
\wxheading{Parameters}
\docparam{x}{Receives the x position of the window.}
\docparam{y}{Receives the y position of the window.}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
\twocolitem{{\bf GetPosition()}}{Returns a wxPoint}
\twocolitem{{\bf GetPositionTuple()}}{Returns a tuple (x, y)}
\end{twocollist}}
}
\membersection{wxWindow::GetName}\label{wxwindowgetname}
\constfunc{virtual wxString }{GetName}{\void}
@@ -676,6 +661,29 @@ 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::GetPosition}\label{wxwindowgetposition}
\constfunc{virtual void}{GetPosition}{\param{int* }{x}, \param{int* }{y}}
\constfunc{wxPoint}{GetPosition}{\void}
This gets the position of the window in pixels, relative to the parent window or
if no parent, relative to the whole display.
\wxheading{Parameters}
\docparam{x}{Receives the x position of the window.}
\docparam{y}{Receives the y position of the window.}
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\indented{2cm}{\begin{twocollist}
\twocolitem{{\bf GetPosition()}}{Returns a wxPoint}
\twocolitem{{\bf GetPositionTuple()}}{Returns a tuple (x, y)}
\end{twocollist}}
}
\membersection{wxWindow::GetRect}\label{wxwindowgetrect}
\constfunc{virtual wxRect}{GetRect}{\void}
@@ -1000,7 +1008,7 @@ Note that the ASCII values do not have explicit key codes: they are passed as AS
values.
Note that not all keypresses can be intercepted this way. If you wish to intercept modifier
keypresses, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
keypresses, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
Most, but not all, windows allow keypresses to be intercepted.
@@ -1037,7 +1045,7 @@ values.
This function is only relevant to top-level windows (frames and dialogs), and under
Windows only. Under GTK the normal EVT\_CHAR\_ event has the functionality, i.e.
you can intercepts it and if you don't call \helpref{wxEvent::Skip}{wxeventskip}
you can intercepts it and if you don't call \helpref{wxEvent::Skip}{wxeventskip}
the window won't get the event.
\wxheading{See also}
@@ -1200,7 +1208,7 @@ use the EVT\_KEY\_DOWN macro in an event table definition. Your {\bf OnKeyDown}
default function to achieve default keypress functionality.
Note that not all keypresses can be intercepted this way. If you wish to intercept special
keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
Most, but not all, windows allow keypresses to be intercepted.
@@ -1229,7 +1237,7 @@ use the EVT\_KEY\_UP macro in an event table definition. Your {\bf OnKeyUp} hand
default function to achieve default keypress functionality.
Note that not all keypresses can be intercepted this way. If you wish to intercept special
keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
keys, such as shift, control, and function keys, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown} or
\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}.
Most, but not all, windows allow key up events to be intercepted.
@@ -1534,6 +1542,11 @@ Note that the size passed is of
the whole window: call \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} for the area which may be
used by the application.
When a window is resized, usually only a small part of the window is damaged and you
may only need to repaint that area. However, if your drawing depends on the size of the window,
you may need to clear the DC explicitly and repaint the whole window. In which case, you
may need to call \helpref{wxWindow::Refresh}{wxwindowrefresh} to invalidate the entire window.
\wxheading{See also}
\helpref{wxSizeEvent}{wxsizeevent},\rtfsp
@@ -1738,7 +1751,7 @@ Physically scrolls the pixels in the window and move child windows accordingly.
\docparam{rect}{Rectangle to invalidate. If this is NULL, the whole window is invalidated. If you
pass a rectangle corresponding to the area of the window exposed by the scroll, your painting handler
can optimise painting by checking for the invalidated region. This paramter is ignored under GTK.}
can optimize painting by checking for the invalidated region. This parameter is ignored under GTK.}
\wxheading{Remarks}
@@ -1756,9 +1769,9 @@ Sets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxa
\func{void}{SetAutoLayout}{\param{bool}{ autoLayout}}
Determines whether the \helpref{wxWindow::Layout}{wxwindowlayout} function will
be called automatically when the window is resized. Use in connection with
\helpref{wxWindow::SetSizer}{wxwindowsetsizer} and
\helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} for layouting subwindows.
be called automatically when the window is resized. Use in connection with
\helpref{wxWindow::SetSizer}{wxwindowsetsizer} and
\helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} for laying out subwindows.
\wxheading{Parameters}
@@ -1802,6 +1815,12 @@ look as the user wishes with run-time loadable modules.
\helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp
\helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground}
\membersection{wxWindow::SetCaret}\label{wxwindowsetcaret}
\constfunc{void}{SetCaret}{\param{wxCaret *}{caret}}
Sets the \helpref{caret}{wxcaret} associated with the window.
\membersection{wxWindow::SetClientSize}\label{wxwindowsetclientsize}
\func{virtual void}{SetClientSize}{\param{int}{ width}, \param{int}{ height}}
@@ -1849,36 +1868,6 @@ be reset back to default.
\helpref{::wxSetCursor}{wxsetcursor}, \helpref{wxCursor}{wxcursor}
\membersection{wxWindow::SetEventHandler}\label{wxwindowseteventhandler}
\func{void}{SetEventHandler}{\param{wxEvtHandler* }{handler}}
Sets the event handler for this window.
\wxheading{Parameters}
\docparam{handler}{Specifies the handler to be set.}
\wxheading{Remarks}
An event handler is an object that is capable of processing the events
sent to a window. By default, the window is its own event handler, but
an application may wish to substitute another, for example to allow
central implementation of event-handling for a variety of different
window classes.
It is usually better to use \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler} since
this sets up a chain of event handlers, where an event not handled by one event handler is
handed to the next one in the chain.
\wxheading{See also}
\helpref{wxWindow::GetEventHandler}{wxwindowgeteventhandler},\rtfsp
\helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler},\rtfsp
\helpref{wxWindow::PopEventHandler}{wxwindowpusheventhandler},\rtfsp
\helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp
\helpref{wxEvtHandler}{wxevthandler}
\membersection{wxWindow::SetConstraints}\label{wxwindowsetconstraints}
\func{void}{SetConstraints}{\param{wxLayoutConstraints* }{constraints}}
@@ -1910,9 +1899,39 @@ If the window already has a drop target, it is deleted.
\wxheading{See also}
\helpref{wxWindow::GetDropTarget}{wxwindowgetdroptarget},
\helpref{wxWindow::GetDropTarget}{wxwindowgetdroptarget},
\helpref{Drag and drop overview}{wxdndoverview}
\membersection{wxWindow::SetEventHandler}\label{wxwindowseteventhandler}
\func{void}{SetEventHandler}{\param{wxEvtHandler* }{handler}}
Sets the event handler for this window.
\wxheading{Parameters}
\docparam{handler}{Specifies the handler to be set.}
\wxheading{Remarks}
An event handler is an object that is capable of processing the events
sent to a window. By default, the window is its own event handler, but
an application may wish to substitute another, for example to allow
central implementation of event-handling for a variety of different
window classes.
It is usually better to use \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler} since
this sets up a chain of event handlers, where an event not handled by one event handler is
handed to the next one in the chain.
\wxheading{See also}
\helpref{wxWindow::GetEventHandler}{wxwindowgeteventhandler},\rtfsp
\helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler},\rtfsp
\helpref{wxWindow::PopEventHandler}{wxwindowpusheventhandler},\rtfsp
\helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp
\helpref{wxEvtHandler}{wxevthandler}
\membersection{wxWindow::SetExtraStyle}\label{wxwindowsetextrastyle}
\func{void}{SetExtraStyle}{\param{long }{exStyle}}
@@ -2297,6 +2316,26 @@ Sets the window's title. Applicable only to frames and dialogs.
Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to
create a new validator of this type.
\membersection{wxWindow::SetToolTip}\label{wxwindowsettooltip}
\func{void}{SetToolTip}{\param{const wxString\& }{tip}}
\func{void}{SetToolTip}{\param{wxToolTip* }{tip}}
Attach a tooltip to the window.
See also: \helpref{GetToolTip}{wxwindowgettooltip},
\helpref{wxToolTip}{wxtooltip}
\membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip}
\constfunc{wxToolTip*}{GetToolTip}{\void}
Get the associated tooltip or NULL if none.
\membersection{wxWindow::SetWindowStyle}\label{wxwindowsetwindowstyle}
\func{void}{SetWindowStyle}{\param{long}{ style}}