X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..d45d30c8682f858321600e2958167d7ef54ebeb5:/docs/latex/wx/window.tex?ds=inline diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index fe1ca0b2c5..9e3be209fa 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -1,34 +1,55 @@ \section{\class{wxWindow}}\label{wxwindow} -wxWindow is the base class for all windows. Any -children of the window will be deleted automatically by the destructor -before the window itself is deleted. +wxWindow is the base class for all windows. Any children of the window will be deleted +automatically by the destructor before the window itself is deleted. + +Please note that we documented a number of handler functions (OnChar(), OnMouse() etc.) in this +help text. These must not be called by a user program and are documented only for illustration. +On several platforms, only a few of these handlers are actually written (they are not always +needed) and if you are uncertain on how to add a certain behaviour to a window class, intercept +the respective event as usual and call \helpref{wxEvent::Skip}{wxeventskip} so that the native +platform can implement its native behaviour or just ignore the event if nothing needs to be +done. \wxheading{Derived from} \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Window styles} The following styles can apply to all windows, although they will not always make sense for a particular -window class. +window class or on all platforms. \twocolwidtha{5cm}% \begin{twocollist}\itemsep=0pt \twocolitem{\windowstyle{wxSIMPLE\_BORDER}}{Displays a thin border around the window. wxBORDER is the old name -for this style.} +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{wxSTATIC\_BORDER}}{Displays a border suitable for a static control.} +\twocolitem{\windowstyle{wxRAISED\_BORDER}}{Displays a raised border. GTK only. } +\twocolitem{\windowstyle{wxSTATIC\_BORDER}}{Displays a border suitable for a static control. Windows only. } \twocolitem{\windowstyle{wxTRANSPARENT\_WINDOW}}{The window is transparent, that is, it will not receive paint events. Windows only.} \twocolitem{\windowstyle{wxNO\_3D}}{Prevents the children of this window taking on 3D styles, even though the application-wide policy is for 3D controls. Windows only.} \twocolitem{\windowstyle{wxTAB\_TRAVERSAL}}{Use this to enable tab traversal for non-dialog windows.} -\twocolitem{\windowstyle{wxVSCROLL}}{Use this style to enable a vertical scrollbar.} -\twocolitem{\windowstyle{wxHSCROLL}}{Use this style to enable a horizontal scrollbar.} +\twocolitem{\windowstyle{wxWANTS\_CHARS}}{Use this to indicate that the window +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 +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 +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?) } +\twocolitem{\windowstyle{wxCLIP\_CHILDREN}}{Use this style to eliminate flicker caused by the background being +repainted, then children being painted over them. Windows only.} \end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -45,10 +66,10 @@ See also \helpref{window styles overview}{windowstyles}. Default constructor. -\func{}{wxWindow}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id}, +\func{}{wxWindow}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, - \param{const long }{style = 0}, + \param{long }{style = 0}, \param{const wxString\& }{name = wxPanelNameStr}} Constructs a window, which can be a child of a frame, dialog or any other non-control window. @@ -64,7 +85,9 @@ should generate a default position for the window. If using the wxWindow class d an actual position.} \docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxWindows -should generate a default size for the window.} +should generate a default size for the window. If no suitable size can be found, the +window will be sized to 20x20 pixels so that the window is visible but obviously not +correctly sized. } \docparam{style}{Window style. For generic window styles, please see \helpref{wxWindow}{wxwindow}.} @@ -110,41 +133,75 @@ release the capture. \membersection{wxWindow::Center}\label{wxwindowcenter} -\func{void}{Center}{\param{const int}{ direction}} +\func{void}{Center}{\param{int}{ direction}} A synonym for \helpref{Centre}{wxwindowcentre}. +\membersection{wxWindow::CenterOnParent}\label{wxwindowcenteronparent} + +\func{void}{CenterOnParent}{\param{int}{ direction}} + +A synonym for \helpref{CentreOnParent}{wxwindowcentreonparent}. + \membersection{wxWindow::Centre}\label{wxwindowcentre} -\func{virtual void}{Centre}{\param{const int}{ direction = wxHORIZONTAL}} +\func{void}{Centre}{\param{int}{ direction = wxHORIZONTAL}} Centres the window. \wxheading{Parameters} \docparam{direction}{Specifies the direction for the centering. May be {\tt wxHORIZONTAL}, {\tt wxVERTICAL}\rtfsp -or {\tt wxBOTH}.} +or {\tt wxBOTH}. It may also include {\tt wxCENTRE\_ON\_SCREEN} flag +if you want to center the window on the entire screen and not on its +parent window.} + +The flag {\tt wxCENTRE\_FRAME} is obsolete and should not be used any longer. \wxheading{Remarks} -The actual behaviour depends on the derived window. For a frame or dialog box, -centring is relative to the whole display. For a panel item, centring is -relative to the panel. +If the window is a top level one (i.e. doesn't have a parent), it will be +centered relative to the screen anyhow. \wxheading{See also} \helpref{wxWindow::Center}{wxwindowcenter} +\membersection{wxWindow::CentreOnParent}\label{wxwindowcentreonparent} + +\func{void}{CentreOnParent}{\param{int}{ direction = wxHORIZONTAL}} + +Centres the window. + +\wxheading{Parameters} + +\docparam{direction}{Specifies the direction for the centering. May be {\tt wxHORIZONTAL}, {\tt wxVERTICAL}\rtfsp +or {\tt wxBOTH}.} + +\wxheading{Remarks} + +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 +\helpref{wxWindow::Centre}{wxwindowcentre}. + +\wxheading{See also} + +\helpref{wxWindow::CenterOnParent}{wxwindowcenteronparent} + \membersection{wxWindow::Clear}\label{wxwindowclear} \func{void}{Clear}{\void} -Clears the window by filling it with the current background colour. +Clears the window by filling it with the current background colour. Does not +cause an erase background event to be generated. \membersection{wxWindow::ClientToScreen} \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 @@ -153,6 +210,17 @@ 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.} + +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{\bf{ClientToScreen(point)}}{Accepts and returns a wxPoint} +\twocolitem{\bf{ClientToScreenXY(x, y)}}{Returns a 2-tuple, (x, y)} +\end{twocollist}} +} + + \membersection{wxWindow::Close}\label{wxwindowclose} \func{virtual bool}{Close}{\param{const bool}{ force = FALSE}} @@ -176,6 +244,14 @@ destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}. Applies to managed windows (wxFrame and wxDialog classes) only. +{\it Note} that calling Close does not guarantee that the window will be destroyed; but it +provides a way to simulate a manual close of a window, which may or may not be implemented by +destroying the window. The default implementation of wxDialog::OnCloseWindow does not +necessarily delete the dialog, since it will simply simulate an wxID\_CANCEL event which +itself only hides the dialog. + +To guarantee that the window will be destroyed, call \helpref{wxWindow::Destroy}{wxwindowdestroy} instead. + \wxheading{See also} \helpref{Window deletion overview}{windowdeletionoverview},\rtfsp @@ -183,6 +259,86 @@ Applies to managed windows (wxFrame and wxDialog classes) only. \helpref{wxWindow::Destroy}{wxwindowdestroy},\rtfsp \helpref{wxCloseEvent}{wxcloseevent} +\membersection{wxWindow::ConvertDialogToPixels}\label{wxwindowconvertdialogtopixels} + +\func{wxPoint}{ConvertDialogToPixels}{\param{const wxPoint\&}{ pt}} + +\func{wxSize}{ConvertDialogToPixels}{\param{const wxSize\&}{ sz}} + +Converts a point or size from dialog units to pixels. + +For the x dimension, the dialog units are multiplied by the average character width +and then divided by 4. + +For the y dimension, the dialog units are multiplied by the average character height +and then divided by 8. + +\wxheading{Remarks} + +Dialog units are used for maintaining a dialog's proportions even if the font changes. +Dialogs created using Dialog Editor optionally use dialog units. + +You can also use these functions programmatically. A convenience macro is defined: + +{\small +\begin{verbatim} +#define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt) +\end{verbatim} +} + +\wxheading{See also} + +\helpref{wxWindow::ConvertPixelsToDialog}{wxwindowconvertpixelstodialog} + +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{\bf{ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint} +\twocolitem{\bf{ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize} +\end{twocollist}} + +Additionally, the following helper functions are defined:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{\bf{wxDLG\_PNT(win, point)}}{Converts a wxPoint from dialog +units to pixels} +\twocolitem{\bf{wxDLG\_SZE(win, size)}}{Converts a wxSize from dialog +units to pixels} +\end{twocollist}} +} + + +\membersection{wxWindow::ConvertPixelsToDialog}\label{wxwindowconvertpixelstodialog} + +\func{wxPoint}{ConvertPixelsToDialog}{\param{const wxPoint\&}{ pt}} + +\func{wxSize}{ConvertPixelsToDialog}{\param{const wxSize\&}{ sz}} + +Converts a point or size from pixels to dialog units. + +For the x dimension, the pixels are multiplied by 4 and then divided by the average +character width. + +For the y dimension, the pixels are multipled by 8 and then divided by the average +character height. + +\wxheading{Remarks} + +Dialog units are used for maintaining a dialog's proportions even if the font changes. +Dialogs created using Dialog Editor optionally use dialog units. + +\wxheading{See also} + +\helpref{wxWindow::ConvertDialogToPixels}{wxwindowconvertdialogtopixels} + + +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{\bf{ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint} +\twocolitem{\bf{ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize} +\end{twocollist}} +} + \membersection{wxWindow::Destroy}\label{wxwindowdestroy} \func{virtual bool}{Destroy}{\void} @@ -238,43 +394,37 @@ Enable or disable the window for user input. \helpref{wxWindow::IsEnabled}{wxwindowisenabled} -\membersection{wxWindow::FakePopupMenu}\label{wxwindowfakepopupmenu} - -\func{virtual bool}{FakePopupMenu}{\param{wxMenu* }{menu}, \param{const int }{x}, \param{const int }{y}} - -A replacement for wxWindow::PopupMenu for cases where the PopupMenu implementation -does not work correctly, in particular on Motif platforms. - -\wxheading{Parameters} - -\docparam{menu}{Menu to pop up.} +\membersection{wxWindow::FindFocus}\label{wxwindowfindfocus} -\docparam{x}{Required x position for the menu to appear.} +\func{static wxWindow*}{FindFocus}{\void} -\docparam{y}{Required y position for the menu to appear.} +Finds the window or control which currently has the keyboard focus. \wxheading{Remarks} -This is a cut-down version of PopupMenu using a dialog and listbox; pull-right menus -are not supported. +Note that this is a static function, so it can be called without needing a wxWindow pointer. \wxheading{See also} -\helpref{wxMenu}{wxmenu}, \helpref{wxWindow::PopupMenu}{wxwindowpopupmenu} +\helpref{wxWindow::SetFocus}{wxwindowsetfocus} -\membersection{wxWindow::FindFocus}\label{wxwindowfindfocus} +\membersection{wxWindow::FindWindow}\label{wxwindowfindwindow} -\func{static wxWindow*}{FindFocus}{\void} +\func{wxWindow*}{FindWindow}{\param{long}{ id}} -Finds the window or control which currently has the keyboard focus. +Find a child of this window, by identifier. -\wxheading{Remarks} +\func{wxWindow*}{FindWindow}{\param{const wxString\&}{ name}} -Note that this is a static function, so it can be called without needing a wxWindow pointer. - -\wxheading{See also} +Find a child of this window, by name. -\helpref{wxWindow::SetFocus}{wxwindowsetfocus} +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{\bf{FindWindowById(id)}}{Accepts an integer} +\twocolitem{\bf{FindWindowByName(name)}}{Accepts a string} +\end{twocollist}} +} \membersection{wxWindow::Fit}\label{wxwindowfit} @@ -309,14 +459,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. @@ -326,6 +478,14 @@ area which may be drawn on by the programmer, excluding title bar, border etc. \docparam{height}{Receives the client height in pixels.} +\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} +\end{twocollist}} +} + \membersection{wxWindow::GetConstraints}\label{wxwindowgetconstraints} \constfunc{wxLayoutConstraints*}{GetConstraints}{\void} @@ -338,6 +498,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} @@ -355,9 +526,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} @@ -392,7 +563,9 @@ Returns the grandparent of a window, or NULL if there isn't one. \constfunc{void*}{GetHandle}{\void} Returns the platform-specific handle of the physical window. Cast it to an appropriate -handle, such as {\bf HWND} for Windows or {\bf Widget} for Motif. +handle, such as {\bf HWND} for Windows, {\bf Widget} for Motif or {\bf GtkWidget} for GTK. + +\pythonnote{This method will return an integer in wxPython.} \membersection{wxWindow::GetId}\label{wxwindowgetid} @@ -402,15 +575,13 @@ Returns the identifier of the window. \wxheading{Remarks} -Each window has an integer identifier. If the application has not provided one, -an identifier will be generated. - -TODO: perhaps there should be a default identifier for each class, rather -choosing one, which could clash with other ones. +Each window has an integer identifier. If the application has not provided one +(or the default Id -1) an unique identifier with a negative value will be generated. \wxheading{See also} -\helpref{wxWindow::SetId}{wxwindowsetid} +\helpref{wxWindow::SetId}{wxwindowsetid}\rtfsp +\helpref{Window identifiers}{windowids} \membersection{wxWindow::GetPosition} @@ -425,9 +596,17 @@ if no parent, relative to the whole display. \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::GetLabel} -\constfunc{virtual wxString\& }{GetLabel}{\void} +\constfunc{virtual wxString }{GetLabel}{\void} Generic way of getting a label from any window, for identification purposes. @@ -442,7 +621,7 @@ by name. \membersection{wxWindow::GetName}\label{wxwindowgetname} -\constfunc{virtual wxString\& }{GetName}{\void} +\constfunc{virtual wxString }{GetName}{\void} Returns the window's name. @@ -461,25 +640,15 @@ 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::GetReturnCode}\label{wxwindowgetreturncode} - -\func{int}{GetReturnCode}{\void} - -Gets the return code for this window. - -\wxheading{Remarks} - -A return code is normally associated with a modal dialog, where \helpref{wxDialog::ShowModal}{wxdialogshowmodal} returns -a code to the application. +\membersection{wxWindow::GetRect}\label{wxwindowgetrect} -\wxheading{See also} +\constfunc{virtual wxRect}{GetRect}{\void} -\helpref{wxWindow::SetReturnCode}{wxwindowsetreturncode}, \helpref{wxDialog::ShowModal}{wxdialogshowmodal},\rtfsp -\helpref{wxDialog::EndModal}{wxdialogendmodal} +Returns the size and position of the window as a \helpref{wxRect}{wxrect} object. \membersection{wxWindow::GetScrollThumb}\label{wxwindowgetscrollthumb} -\func{virtual int}{GetScrollThumb}{\param{const int }{orientation}} +\func{virtual int}{GetScrollThumb}{\param{int }{orientation}} Returns the built-in scrollbar thumb size. @@ -489,7 +658,7 @@ Returns the built-in scrollbar thumb size. \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos} -\func{virtual int}{GetScrollPos}{\param{const int }{orientation}} +\func{virtual int}{GetScrollPos}{\param{int }{orientation}} Returns the built-in scrollbar position. @@ -499,7 +668,7 @@ See \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar} \membersection{wxWindow::GetScrollRange}\label{wxwindowgetscrollrange} -\func{virtual int}{GetScrollRange}{\param{const int }{orientation}} +\func{virtual int}{GetScrollRange}{\param{int }{orientation}} Returns the built-in scrollbar range. @@ -507,10 +676,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} @@ -519,6 +690,14 @@ This gets the size of the entire window in pixels. \docparam{height}{Receives the window height.} +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{\bf{GetSize()}}{Returns a wxSize} +\twocolitem{\bf{GetSizeTuple()}}{Returns a 2-tuple (width, height)} +\end{twocollist}} +} + \membersection{wxWindow::GetTextExtent} \constfunc{virtual void}{GetTextExtent}{\param{const wxString\& }{string}, \param{int* }{x}, \param{int* }{y}, @@ -544,6 +723,17 @@ window with the currently selected font. \docparam{use16}{If TRUE, {\it string} contains 16-bit characters. The default is FALSE.} + +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{\bf{GetTextExtent(string)}}{Returns a 2-tuple, (width, height)} +\twocolitem{\bf{GetFullTextExtent(string, font=NULL)}}{Returns a +4-tuple, (width, height, descent, externalLeading) } +\end{twocollist}} +} + + \membersection{wxWindow::GetTitle}\label{wxwindowgettitle} \func{virtual wxString}{GetTitle}{\void} @@ -554,11 +744,29 @@ 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::GetValidator}\label{wxwindowgetvalidator} + +\constfunc{wxValidator*}{GetValidator}{\void} + +Returns a pointer to the current validator for the window, or NULL if there is none. + \membersection{wxWindow::GetWindowStyleFlag} \constfunc{long}{GetWindowStyleFlag}{\void} Gets the window style that was passed to the consructor or {\bf Create} member. +{\bf GetWindowStyle} is synonymous. \membersection{wxWindow::InitDialog}\label{wxwindowinitdialog} @@ -581,6 +789,20 @@ Returns TRUE if the window is enabled for input, FALSE otherwise. \helpref{wxWindow::Enable}{wxwindowenable} +\membersection{wxWindow:IsExposed}\label{wxwindowisexposed} + +\constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}} + +\constfunc{bool}{IsExposed}{\param{wxPoint }{&pt}} + +\constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}, \param{int }{w}, \param{int }{h}} + +\constfunc{bool}{IsExposed}{\param{wxRect }{&rect}} + +Returns TRUE if the given point or rectange area has been exposed since the +last repaint. Call this in an paint event handler to optimize redrawing by +only redrawing those areas, which have been exposed. + \membersection{wxWindow::IsRetained}\label{wxwindowisretained} \constfunc{virtual bool}{IsRetained}{\void} @@ -597,12 +819,23 @@ Retained windows are only available on X platforms. Returns TRUE if the window is shown, FALSE if it has been hidden. +\membersection{wxWindow::IsTopLevel}\label{wxwindowistoplevel} + +\constfunc{bool}{IsTopLevel}{\void} + +Returns TRUE if the given window is a top-level one. Currently all frames and +dialogs are considered to be top-level windows (even if they have a parent +window). + \membersection{wxWindow::Layout}\label{wxwindowlayout} \func{void}{Layout}{\void} -Invokes the constraint-based layout algorithm for this window. It is called -automatically by the default {\bf wxWindow::OnSize} member. +Invokes the constraint-based layout algorithm or the sizer-based algorithm +for this window. + +See \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} on when +this function gets called automatically using auto layout. \membersection{wxWindow::LoadFromResource}\label{wxwindowloadfromresource} @@ -624,14 +857,6 @@ default resource table will be used.} TRUE if the operation succeeded, otherwise FALSE. -\wxheading{Remarks} - -TODO - -\wxheading{See also} - -TODO - \membersection{wxWindow::Lower}\label{wxwindowlower} \func{void}{Lower}{\void} @@ -644,7 +869,8 @@ or frame). \func{virtual void}{MakeModal}{\param{const bool }{flag}} Disables all other windows in the application so that -the user can only interact with this window. +the user can only interact with this window. (This function +is not implemented anywhere). \wxheading{Parameters} @@ -653,7 +879,9 @@ the user can only interact with this window. If FALSE, the effect is reversed.} \membersection{wxWindow::Move}\label{wxwindowmove} -\func{void}{Move}{\param{const int}{ x}, \param{const int}{ y}} +\func{void}{Move}{\param{int}{ x}, \param{int}{ y}} + +\func{void}{Move}{\param{const wxPoint\&}{ pt}} Moves the window to the given position. @@ -663,6 +891,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 @@ -677,6 +907,14 @@ as the call: \helpref{wxWindow::SetSize}{wxwindowsetsize} +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{\bf{Move(point)}}{Accepts a wxPoint} +\twocolitem{\bf{MoveXY(x, y)}}{Accepts a pair of integers} +\end{twocollist}} +} + \membersection{wxWindow::OnActivate}\label{wxwindowonactivate} \func{void}{OnActivate}{\param{wxActivateEvent\&}{ event}} @@ -701,7 +939,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 that is not a modifier (SHIFT, CONTROL or ALT). \wxheading{Parameters} @@ -717,10 +955,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 modifier +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. \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} @@ -749,7 +992,9 @@ Note that the ASCII values do not have explicit key codes: they are passed as AS values. This function is only relevant to top-level windows (frames and dialogs), and under -Windows only. +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} +the window won't get the event. \wxheading{See also} @@ -787,7 +1032,7 @@ the control(s) in question. Called when the user has tried to close a a frame or dialog box using the window manager (X) or system menu (Windows). -{\bf Note:} This is an obsolete function retained for backward compatibility. +{\bf Note:} This is an obsolete function. It is superceded by the \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} event handler. @@ -797,10 +1042,6 @@ If TRUE is returned by OnClose, the window will be deleted by the system, otherw attempt will be ignored. Do not delete the window from within this handler, although you may delete other windows. -\wxheading{Remarks} - -Derive your own class to handle this message. The default handler returns FALSE. - \wxheading{See also} \helpref{Window deletion overview}{windowdeletionoverview},\rtfsp @@ -824,6 +1065,14 @@ using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}. If this is TRUE, destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}. If not, it is up to you whether you respond by destroying the window. +(Note: GetForce is now superceded by CanVeto. So to test whether forced destruction of +the window is required, test for the negative of CanVeto. If CanVeto returns FALSE, +it is not possible to skip window deletion.) + +If you don't destroy the window, you should call \helpref{wxCloseEvent::Veto}{wxcloseeventveto} to +let the calling code know that you did not destroy the window. This allows the \helpref{wxWindow::Close}{wxwindowclose} function +to return TRUE or FALSE depending on whether the close instruction was honoured or not. + \wxheading{Remarks} The \helpref{wxWindow::OnClose}{wxwindowonclose} virtual function remains @@ -837,22 +1086,9 @@ destroying the window if it returns TRUE or if the close is being forced. \helpref{wxWindow::Close}{wxwindowclose},\rtfsp \helpref{wxWindow::OnClose}{wxwindowonclose},\rtfsp \helpref{wxWindow::Destroy}{wxwindowdestroy},\rtfsp -\helpref{wxCloseEvent}{wxcloseevent} - -\membersection{wxWindow::OnDefaultAction}\label{wxwindowondefaultaction} - -\func{virtual void}{OnDefaultAction}{\param{wxControl* }{control}} - -Called when the user initiates the default action for a panel or -dialog box, for example by double clicking on a listbox. - -\wxheading{Parameters} - -\docparam{control}{The control which caused the default action.} - -\wxheading{Remarks} - -TODO: eliminate this?? Or keep it for backward compatibility? +\helpref{wxCloseEvent}{wxcloseevent},\rtfsp +\helpref{wxApp::OnQueryEndSession}{wxapponqueryendsession},\rtfsp +\helpref{wxApp::OnEndSession}{wxapponendsession} \membersection{wxWindow::OnDropFiles}\label{wxwindowondropfiles} @@ -890,7 +1126,9 @@ Called when the background of the window needs to be erased. \wxheading{Remarks} -This event is only generated under Windows. +This event is only generated under Windows. It is therefore recommended that +you set the text background colour explicitly in order to prevent flicker. +The default background colour under GTK is grey. To intercept this event, use the EVT\_ERASE\_BACKGROUND macro in an event table definition. @@ -898,6 +1136,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}} @@ -921,7 +1218,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. @@ -1085,7 +1382,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} @@ -1099,7 +1396,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) { @@ -1129,9 +1426,9 @@ void MyWindow::OnPaint(wxPaintEvent& event) \membersection{wxWindow::OnScroll}\label{wxwindowonscroll} -\func{void}{OnScroll}{\param{wxScrollEvent\& }{event}} +\func{void}{OnScroll}{\param{wxScrollWinEvent\& }{event}} -Called when a scroll event is received from one of the window's built-in scrollbars. +Called when a scroll window event is received from one of the window's built-in scrollbars. \wxheading{Parameters} @@ -1147,7 +1444,7 @@ for horizontal events). \wxheading{See also} -\helpref{wxScrollEvent}{wxscrollevent},\rtfsp +\helpref{wxScrollWinEvent}{wxscrollwinevent},\rtfsp \helpref{Event handling overview}{eventhandlingoverview} \membersection{wxWindow::OnSetFocus}\label{wxwindowonsetfocus} @@ -1198,7 +1495,7 @@ used by the application. \func{void}{OnSysColourChanged}{\param{wxOnSysColourChangedEvent\& }{event}} -Called when the user has changed the system colours. +Called when the user has changed the system colours. Windows only. \wxheading{Parameters} @@ -1230,32 +1527,42 @@ default value is FALSE.} \membersection{wxWindow::PopupMenu}\label{wxwindowpopupmenu} -\func{virtual bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const int }{x}, \param{const int }{y}} +\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const wxPoint& }{pos}} + +\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{int }{x}, \param{int }{y}} Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a -menu item is selected, the callback defined for the menu is called with -wxMenu and wxCommandEvent reference arguments. The callback should access -the commandInt member of the event to check the selected menu identifier. +menu item is selected, the corresponding menu event is generated and will be +processed as usually. \wxheading{Parameters} \docparam{menu}{Menu to pop up.} +\docparam{pos}{The position where the menu will appear.} + \docparam{x}{Required x position for the menu to appear.} \docparam{y}{Required y position for the menu to appear.} -\wxheading{Remarks} +\wxheading{See also} -Valid only for subwindows (panels, canvases and text windows). +\helpref{wxMenu}{wxmenu} -Sometimes this function does not function correctly under Motif, in which case -please use \helpref{wxWindow::FakePopupMenu}{wxwindowfakepopupmenu} instead. +\wxheading{Remarks} -\wxheading{See also} +Just before the menu is popped up, \helpref{wxMenu::UpdateUI}{wxmenuupdateui} is called +to ensure that the menu items are in the correct state. The menu does not get deleted +by the window. -\helpref{wxMenu}{wxmenu}, \helpref{wxWindow::FakePopupMenu}{wxwindowfakepopupmenu} +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{\bf{PopupMenu(menu, point)}}{Specifies position with a wxPoint} +\twocolitem{\bf{PopupMenuXY(menu, x, y)}}{Specifies position with two integers (x, y)} +\end{twocollist}} +} \membersection{wxWindow::PushEventHandler}\label{wxwindowpusheventhandler} @@ -1332,10 +1639,25 @@ functions so should not be required by the application programmer. \docparam{child}{Child window to remove.} -\membersection{wxWindow::ScreenToClient} +\membersection{wxWindow::Reparent}\label{wxwindowreparent} + +\func{virtual bool}{Reparent}{\param{wxWindow* }{newParent}} + +Reparents the window, i.e the window will be removed from its +current parent window (e.g. a non-standard toolbar in a wxFrame) +and then re-inserted into another (e.g. a wxMiniFrame for a +floating toolbar). Available on Windows and GTK+. + +\wxheading{Parameters} + +\docparam{newParent}{New parent.} + +\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} @@ -1344,11 +1666,22 @@ 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.} + +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{\bf{ScreenToClient(point)}}{Accepts and returns a wxPoint} +\twocolitem{\bf{ScreenToClientXY(x, y)}}{Returns a 2-tuple, (x, y)} +\end{twocollist}} +} + + \membersection{wxWindow::ScrollWindow}\label{wxwindowscrollwindow} -\func{virtual void}{ScrollWindow}{\param{const int }{dx}, \param{const int }{dy}, \param{const wxRect*}{ rect = NULL}} +\func{virtual void}{ScrollWindow}{\param{int }{dx}, \param{int }{dy}, \param{const wxRect*}{ rect = NULL}} -Physically scrolls the pixels in the window. +Physically scrolls the pixels in the window and move child windows accordingly. \wxheading{Parameters} @@ -1358,27 +1691,42 @@ Physically scrolls the pixels in the window. \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.} +can optimise painting by checking for the invalidated region. This paramter is ignored under GTK, +instead the regions to be invalidated are calculated automatically. } \wxheading{Remarks} -Available only under Windows. - Use this function to optimise your scrolling implementations, to minimise the area that must be -redrawn. +redrawn. Note that it is rarely required to call this function from a user program. + +\membersection{wxWindow::SetAcceleratorTable}\label{wxwindowsetacceleratortable} + +\func{virtual void}{SetAcceleratorTable}{\param{const wxAcceleratorTable\&}{ accel}} + +Sets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxacceleratortable}. \membersection{wxWindow::SetAutoLayout}\label{wxwindowsetautolayout} \func{void}{SetAutoLayout}{\param{const bool}{ autoLayout}} Determines whether the \helpref{wxWindow::Layout}{wxwindowlayout} function will -be called automatically when the window is resized. +be called automatically when the window is resized. Use in connection with +\helpref{wxWindow::SetSizer}{wxwindowsetsizer} and +\helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} for layouting subwindows. \wxheading{Parameters} \docparam{autoLayout}{Set this to TRUE if you wish the Layout function to be called from within wxWindow::OnSize functions.} +\wxheading{Remarks} + +Note that this function is actually disabled for wxWindow. It has +effect for wxDialog, wxFrame, wxPanel and wxScrolledWindow. Windows +of other types that need to invoke the Layout algorithm should provide +an EVT_SIZE handler and call +\helpref{wxWindow::Layout}{wxwindowlayout} from within it. + \wxheading{See also} \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} @@ -1396,15 +1744,99 @@ Sets the background colour of the window. \wxheading{Remarks} The background colour is usually painted by the default\rtfsp -\helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground} event handler function. +\helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground} event handler function +under Windows and automatically under GTK. + +Note that setting the background colour does not cause an immediate refresh, so you +may wish to call \helpref{wxWindow::Clear}{wxwindowclear} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after +calling this function. + +Note that when using this functions under GTK, you will disable the so called "themes", +i.e. the user chosen apperance of windows and controls, including the themes of +their parent windows. \wxheading{See also} \helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour},\rtfsp \helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp +\helpref{wxWindow::Clear}{wxwindowclear},\rtfsp +\helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp \helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground} +\membersection{wxWindow::SetClientSize}\label{wxwindowsetclientsize} + +\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 +around panel items, for example. + +\wxheading{Parameters} + +\docparam{width}{The required client area width.} + +\docparam{height}{The required client area height.} + +\docparam{size}{The required client size.} + +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{\bf{SetClientSize(size)}}{Accepts a wxSize} +\twocolitem{\bf{SetClientSizeWH(width, height)}}{} +\end{twocollist}} +} + +\membersection{wxWindow::SetCursor}\label{wxwindowsetcursor} + +\func{virtual void}{SetCursor}{\param{const wxCursor\&}{cursor}} + +Sets the window's cursor. Notice that setting the cursor for this window does +not set it for its children so you'll need to explicitly call SetCursor() for +them too if you need it. + +\wxheading{Parameters} + +\docparam{cursor}{Specifies the cursor that the window should normally display.} + +\wxheading{See also} + +\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}} @@ -1422,15 +1854,22 @@ constraints.} \wxheading{Remarks} You must call \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} to tell a window to use -the constraints automatically in OnSize; otherwise, you must -override OnSize and call Layout explicitly. +the constraints automatically in OnSize; otherwise, you must override OnSize and call Layout() +explicitly. When setting both a wxLayoutConstraints and a \helpref{wxSizer}{wxsizer}, only the +sizer will have effect. + +\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} -% TODO: double click should always be allowed. -%\membersection{wxWindow::SetDoubleClick}\label{setdoubleclick} -% -%\func{void}{SetDoubleClick}{\param{bool}{ allowDoubleClick}} -% -%For canvases, allows double click if {\it allowDoubleClick} is TRUE. The default is FALSE. +\helpref{wxWindow::GetDropTarget}{wxwindowgetdroptarget}, +\helpref{Drag and drop overview}{wxdndoverview} \membersection{wxWindow::SetFocus}\label{wxwindowsetfocus} @@ -1468,6 +1907,10 @@ The interpretation of foreground colour is open to interpretation according to the window class; it may be the text colour or other colour, or it may not be used at all. +Note that when using this functions under GTK, you will disable the so called "themes", +i.e. the user chosen apperance of windows and controls, including the themes of +their parent windows. + \wxheading{See also} \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp @@ -1486,13 +1929,10 @@ Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently. -TODO: perhaps there should be a default identifier for each class, rather -choosing one, which could clash with other ones. - \wxheading{See also} -\helpref{wxWindow::GetId}{wxwindowgetid} - +\helpref{wxWindow::GetId}{wxwindowgetid},\rtfsp +\helpref{Window identifiers}{windowids} \membersection{wxWindow::SetName}\label{wxwindowsetname} @@ -1508,30 +1948,16 @@ Sets the window's name. \helpref{wxWindow::GetName}{wxwindowgetname} -\membersection{wxWindow::SetReturnCode}\label{wxwindowsetreturncode} - -\func{void}{SetReturnCode}{\param{int }{retCode}} - -Sets the return code for this window. - -\wxheading{Parameters} - -\docparam{retCode}{The integer return code, usually a control identifier.} - -\wxheading{Remarks} - -A return code is normally associated with a modal dialog, where \helpref{wxDialog::ShowModal}{wxdialogshowmodal} returns -a code to the application. The function \helpref{wxDialog::EndModal}{wxdialogendmodal} calls {\bf SetReturnCode}. +\membersection{wxWindow::SetPalette}\label{wxwindowsetpalette} -\wxheading{See also} +\func{virtual void}{SetPalette}{\param{wxPalette* }{palette}} -\helpref{wxWindow::GetReturnCode}{wxwindowgetreturncode}, \helpref{wxDialog::ShowModal}{wxdialogshowmodal},\rtfsp -\helpref{wxDialog::EndModal}{wxdialogendmodal} +Obsolete - use \helpref{wxDC::SetPalette}{wxdcsetpalette} instead. \membersection{wxWindow::SetScrollbar}\label{wxwindowsetscrollbar} -\func{virtual void}{SetScrollbar}{\param{const int }{orientation}, \param{const int }{position},\rtfsp -\param{const int }{thumbSize}, \param{const int }{range},\rtfsp +\func{virtual void}{SetScrollbar}{\param{int }{orientation}, \param{int }{position},\rtfsp +\param{int }{thumbSize}, \param{int }{range},\rtfsp \param{const bool }{refresh = TRUE}} Sets the scrollbar properties of a built-in scrollbar. @@ -1581,7 +2007,7 @@ from your \helpref{wxWindow::OnSize}{wxwindowonsize} event handler function. \begin{comment} \membersection{wxWindow::SetScrollPage}\label{wxwindowsetscrollpage} -\func{virtual void}{SetScrollPage}{\param{const int }{orientation}, \param{const int }{pageSize}, \param{const bool }{refresh = TRUE}} +\func{virtual void}{SetScrollPage}{\param{int }{orientation}, \param{int }{pageSize}, \param{const bool }{refresh = TRUE}} Sets the page size of one of the built-in scrollbars. @@ -1612,16 +2038,14 @@ handling of pages and ranges. \wxheading{See also} \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp -\helpref{wxWindow::SetScrollRange}{wxwindowsetscrollpage},\rtfsp \helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp -\helpref{wxWindow::GetScrollRange}{wxwindowsetscrollrange},\rtfsp -\helpref{wxWindow::GetScrollPage}{wxwindowsetscrollrange},\rtfsp +\helpref{wxWindow::GetScrollPage}{wxwindowsetscrollpage},\rtfsp \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow} \end{comment} \membersection{wxWindow::SetScrollPos}\label{wxwindowsetscrollpos} -\func{virtual void}{SetScrollPos}{\param{const int }{orientation}, \param{const int }{pos}, \param{const bool }{refresh = TRUE}} +\func{virtual void}{SetScrollPos}{\param{int }{orientation}, \param{int }{pos}, \param{const bool }{refresh = TRUE}} Sets the position of one of the built-in scrollbars. @@ -1642,14 +2066,13 @@ application to take note of scrollbar attributes and redraw contents accordingly \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar},\rtfsp \helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp -\helpref{wxWindow::GetScrollRange}{wxwindowsetscrollrange},\rtfsp -\helpref{wxWindow::GetScrollThumb}{wxwindowsetscrollthumb},\rtfsp +\helpref{wxWindow::GetScrollThumb}{wxwindowgetscrollthumb},\rtfsp \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow} \begin{comment} \membersection{wxWindow::SetScrollRange}\label{wxwindowsetscrollrange} -\func{virtual void}{SetScrollRange}{\param{const int }{orientation}, \param{const int }{range}, \param{const bool }{refresh = TRUE}} +\func{virtual void}{SetScrollRange}{\param{int }{orientation}, \param{int }{range}, \param{const bool }{refresh = TRUE}} Sets the range of one of the built-in scrollbars. @@ -1664,9 +2087,9 @@ Sets the range of one of the built-in scrollbars. \wxheading{Remarks} The range of a scrollbar is the number of steps that the thumb may travel, rather than the total -object length of the scrollbar. If you are implementing a scrolling canvas, for example, you -would adjust the scroll range when the canvas is resized, by subtracting the canvas view size from the -total virtual canvas size. When the two sizes are the same (all the canvas is visible), the range goes to zero +object length of the scrollbar. If you are implementing a scrolling window, for example, you +would adjust the scroll range when the window is resized, by subtracting the window view size from the +total virtual window size. When the two sizes are the same (all the window is visible), the range goes to zero and usually the scrollbar will be automatically hidden. \wxheading{See also} @@ -1674,19 +2097,22 @@ and usually the scrollbar will be automatically hidden. \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp \helpref{wxWindow::SetScrollPage}{wxwindowsetscrollpage},\rtfsp \helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp -\helpref{wxWindow::GetScrollRange}{wxwindowsetscrollrange},\rtfsp -\helpref{wxWindow::GetScrollPage}{wxwindowsetscrollrange},\rtfsp +\helpref{wxWindow::GetScrollPage}{wxwindowsetscrollpage},\rtfsp \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow} \end{comment} \membersection{wxWindow::SetSize}\label{wxwindowsetsize} -\func{virtual void}{SetSize}{\param{const int}{ x}, \param{const int}{ y}, \param{const int}{ width}, \param{int}{ height}, - \param{const int}{ sizeFlags = wxSIZE\_AUTO}} +\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{const int}{ width}, \param{const int}{ height}} +\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. @@ -1704,6 +2130,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 @@ -1731,10 +2161,19 @@ by wxWindows, or that the current value of the dimension should be used. \helpref{wxWindow::Move}{wxwindowmove} +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{\bf{SetDimensions(x, y, width, height, sizeFlags=wxSIZE_AUTO)}}{} +\twocolitem{\bf{SetSize(size)}}{} +\twocolitem{\bf{SetPosition(point)}}{} +\end{twocollist}} +} + \membersection{wxWindow::SetSizeHints}\label{wxwindowsetsizehints} -\func{virtual void}{SetSizeHints}{\param{const int}{ minW=-1}, \param{const int}{ minH=-1}, \param{const int}{ maxW=-1}, \param{int}{ maxH=-1}, - \param{const int}{ incW=-1}, \param{const int}{ incH=-1}} +\func{virtual void}{SetSizeHints}{\param{int}{ minW=-1}, \param{int}{ minH=-1}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}, + \param{int}{ incW=-1}, \param{int}{ incH=-1}} Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. @@ -1760,76 +2199,26 @@ given bounds. The resizing increments are only significant under Motif or Xt. -\membersection{wxWindow::SetClientSize} - -\func{virtual void}{SetClientSize}{\param{const int}{ width}, \param{const int}{ height}} - -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 -around panel items, for example. - -\wxheading{Parameters} - -\docparam{width}{The required client area width.} - -\docparam{height}{The required client area height.} - -\membersection{wxWindow::SetPalette} - -\func{virtual void}{SetPalette}{\param{wxPalette* }{palette}} - -Obsolete - use \helpref{wxDC::SetPalette}{wxdcsetpalette} instead. - -\membersection{wxWindow::SetCursor}\label{wxwindowsetcursor} - -\func{virtual void}{SetCursor}{\param{const wxCursor\&}{cursor}} - -Sets the window's cursor. - -\wxheading{Parameters} - -\docparam{cursor}{Specifies the cursor that the window should normally display.} - -\wxheading{Remarks} - -Under Windows, you sometimes need to call ::wxSetCursor in addition to this -function if you want the cursor to change immediately, because under Windows, -wxWindows only sets the global cursor when it detects mouse movement. - -\wxheading{See also} - -\helpref{::wxSetCursor}{wxsetcursor}, \helpref{wxCursor}{wxcursor} +\membersection{wxWindow::SetSizer}\label{wxwindowsetsizer} -\membersection{wxWindow::SetEventHandler}\label{wxwindowseteventhandler} - -\func{void}{SetEventHandler}{\param{wxEvtHandler* }{handler}} +\func{void}{SetSizer}{\param{wxSizer* }{sizer}} -Sets the event handler for this window. +Sets the window to have the given layout sizer. The window +will then own the object, and will take care of its deletion. +If an existing layout constraints object is already owned by the +window, it will be deleted. \wxheading{Parameters} -\docparam{handler}{Specifies the handler to be set.} +\docparam{sizer}{The sizer to set. Pass NULL to disassociate and delete the window's +sizer.} \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} +You must call \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} to tell a window to use +the sizer automatically in OnSize; otherwise, you must override OnSize and call Layout() +explicitly. When setting both a wxSizer and a \helpref{wxLayoutConstraints}{wxlayoutconstraints}, +only the sizer will have effect. \membersection{wxWindow::SetTitle}\label{wxwindowsettitle} @@ -1845,7 +2234,14 @@ Sets the window's title. Applicable only to frames and dialogs. \helpref{wxWindow::GetTitle}{wxwindowgettitle} -\membersection{wxWindow::Show} +\membersection{wxWindow::SetValidator}\label{wxwindowsetvalidator} + +\func{virtual void}{SetValidator}{\param{const wxValidator\&}{ validator}} + +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::Show}\label{wxwindowshow} \func{virtual bool}{Show}{\param{const bool}{ show}}