X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/387a3b02e02d91da6c5d4331b667d835e32c83b0..b953bdc2934895fa31d859be25be1f850701c2c3:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 6576b10ada..f086ccca6a 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -20,7 +20,7 @@ window class. for this style.} \twocolitem{\windowstyle{wxDOUBLE\_BORDER}}{Displays a double border. Windows only.} \twocolitem{\windowstyle{wxSUNKEN\_BORDER}}{Displays a sunken border.} -\twocolitem{\windowstyle{wxRAISED\_BORDER}}{Displays a sunken border.} +\twocolitem{\windowstyle{wxRAISED\_BORDER}}{Displays a raised border.} \twocolitem{\windowstyle{wxSTATIC\_BORDER}}{Displays a border suitable for a static control.} \twocolitem{\windowstyle{wxTRANSPARENT\_WINDOW}}{The window is transparent, that is, it will not receive paint events. Windows only.} @@ -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}} @@ -375,14 +379,16 @@ Returns the average character width for this window. \membersection{wxWindow::GetChildren} -\func{wxList*}{GetChildren}{\void} +\func{wxList\&}{GetChildren}{\void} -Returns a pointer to the list of the window's children. +Returns a reference to the list of the window's children. \membersection{wxWindow::GetClientSize}\label{wxwindowgetclientsize} \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. @@ -404,6 +410,17 @@ Returns a pointer to the window's layout constraints, or NULL if there are none. Returns a pointer to the button which is the default for this window, or NULL. +\membersection{wxWindow::GetDropTarget}\label{wxwindowgetdroptarget} + +\constfunc{wxDropTarget*}{GetDropTarget}{\void} + +Returns the associated drop target, which may be NULL. + +\wxheading{See also} + +\helpref{wxWindow::SetDropTarget}{wxwindowsetdroptarget}, +\helpref{Drag and drop overview}{wxdndoverview} + \membersection{wxWindow::GetEventHandler}\label{wxwindowgeteventhandler} \constfunc{wxEvtHandler*}{GetEventHandler}{\void} @@ -421,9 +438,9 @@ own event handler. \membersection{wxWindow::GetFont}\label{wxwindowgetfont} -\constfunc{wxFont*}{GetFont}{\void} +\constfunc{wxFont\&}{GetFont}{\void} -Returns a pointer to the font for this window. +Returns a reference to the font for this window. \wxheading{See also} @@ -527,6 +544,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 +596,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} @@ -620,6 +645,17 @@ Gets the window's title. Applicable only to frames and dialogs. \helpref{wxWindow::SetTitle}{wxwindowsettitle} +\membersection{wxWindow::GetUpdateRegion}\label{wxwindowgetupdateregion} + +\constfunc{virtual wxRegion}{GetUpdateRegion}{\void} + +Returns the region specifying which parts of the window have been damaged. Should +only be called within an \helpref{OnPaint}{wxwindowonpaint} event handler. + +\wxheading{See also} + +\helpref{wxRegion}{wxregion}, \helpref{wxRegionIterator}{wxregioniterator}, \helpref{wxWindow::OnPaint}{wxwindowonpaint} + \membersection{wxWindow::GetWindowStyleFlag} \constfunc{long}{GetWindowStyleFlag}{\void} @@ -721,6 +757,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} @@ -729,6 +767,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 @@ -767,7 +807,7 @@ otherwise it returns FALSE (it is being deactivated). \func{void}{OnChar}{\param{wxKeyEvent\&}{ event}} -Called when the user has pressed a key. +Called when the user has pressed a key, which has been translated into an ASCII value. \wxheading{Parameters} @@ -783,10 +823,15 @@ default function to achieve default keypress functionality. Note that the ASCII values do not have explicit key codes: they are passed as ASCII values. +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 +\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}. + Most, but not all, windows allow keypresses to be intercepted. \wxheading{See also} +\helpref{wxWindow::OnKeyDown}{wxwindowonkeydown}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp \helpref{Event handling overview}{eventhandlingoverview} @@ -959,6 +1004,65 @@ To intercept this event, use the EVT\_ERASE\_BACKGROUND macro in an event table \helpref{wxEraseEvent}{wxeraseevent}, \helpref{Event handling overview}{eventhandlingoverview} +\membersection{wxWindow::OnKeyDown}\label{wxwindowonkeydown} + +\func{void}{OnKeyDown}{\param{wxKeyEvent\&}{ event}} + +Called when the user has pressed a key, before it is translated into an ASCII value using other +modifier keys that might be pressed at the same time. + +\wxheading{Parameters} + +\docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for +details about this class.} + +\wxheading{Remarks} + +This member function is called in response to a key down event. To intercept this event, +use the EVT\_KEY\_DOWN macro in an event table definition. Your {\bf OnKeyDown} handler may call this +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 +\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}. + +Most, but not all, windows allow keypresses to be intercepted. + +\wxheading{See also} + +\helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp +\helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp +\helpref{Event handling overview}{eventhandlingoverview} + +\membersection{wxWindow::OnKeyUp}\label{wxwindowonkeyup} + +\func{void}{OnKeyUp}{\param{wxKeyEvent\&}{ event}} + +Called when the user has released a key. + +\wxheading{Parameters} + +\docparam{event}{Object containing keypress information. See \helpref{wxKeyEvent}{wxkeyevent} for +details about this class.} + +\wxheading{Remarks} + +This member function is called in response to a key up event. To intercept this event, +use the EVT\_KEY\_UP macro in an event table definition. Your {\bf OnKeyUp} handler may call this +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 +\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}. + +Most, but not all, windows allow key up events to be intercepted. + +\wxheading{See also} + +\helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown},\rtfsp +\helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp +\helpref{Event handling overview}{eventhandlingoverview} + \membersection{wxWindow::OnKillFocus}\label{wxwindowonkillfocus} \func{void}{OnKillFocus}{\param{wxFocusEvent\& }{event}} @@ -982,7 +1086,7 @@ Most, but not all, windows respond to this event. \membersection{wxWindow::OnIdle}\label{wxwindowonidle} -\func{void}{Onidle}{\param{wxIdleEvent\& }{event}} +\func{void}{OnIdle}{\param{wxIdleEvent\& }{event}} Provide this member function for any processing which needs to be done when the application is idle. @@ -1146,7 +1250,7 @@ terms of the client area, and are unscrolled, so you will need to do some calculations using the current view position to obtain logical, scrolled units. -Here is an example of using the \helpref{wxUpdateIterator}{wxupdateiterator} class: +Here is an example of using the \helpref{wxRegionIterator}{wxregioniterator} class: {\small% \begin{verbatim} @@ -1160,7 +1264,7 @@ void MyWindow::OnPaint(wxPaintEvent& event) ViewStart(&vbX,&vbY); int vX,vY,vW,vH; // Dimensions of client area in pixels - wxUpdateIterator upd(this); // get the update rect list + wxRegionIterator upd(GetUpdateRegion()); // get the update rect list while (upd) { @@ -1188,6 +1292,8 @@ void MyWindow::OnPaint(wxPaintEvent& event) \helpref{wxPaintDC}{wxpaintdc},\rtfsp \helpref{Event handling overview}{eventhandlingoverview} +\membersection{wxWindow::OnScroll}\label{wxwindowonscroll} + \func{void}{OnScroll}{\param{wxScrollEvent\& }{event}} Called when a scroll event is received from one of the window's built-in scrollbars. @@ -1384,10 +1490,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} @@ -1396,6 +1504,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}} @@ -1483,6 +1593,19 @@ You must call \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} to tell a the constraints automatically in OnSize; otherwise, you must override OnSize and call Layout explicitly. +\membersection{wxWindow::SetDropTarget}\label{wxwindowsetdroptarget} + +\func{void}{SetDropTarget}{\param{wxDropTarget*}{ target}} + +Associates a drop target with this window. + +If the window already has a drop target, it is deleted. + +\wxheading{See also} + +\helpref{wxWindow::GetDropTarget}{wxwindowgetdroptarget}, +\helpref{Drag and drop overview}{wxdndoverview} + \membersection{wxWindow::SetFocus}\label{wxwindowsetfocus} \func{virtual void}{SetFocus}{\void} @@ -1731,10 +1854,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} @@ -1751,6 +1878,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 @@ -1811,6 +1942,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 @@ -1822,6 +1955,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}}