X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c66c3af1353948c39b05ab03c7314d6f999419d0..f973828cd9b31d3b80386fab5e6f7c4a106d97fc:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index d3e45063f3..eaab1fc066 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -21,7 +21,6 @@ class, wxWindows uses a unique protected virtual \texttt{DoGetXXX()} method and all \texttt{GetXXX()} ones are forwarded to it, so overriding the former changes the behaviour of the latter. - \wxheading{Derived from} \helpref{wxEvtHandler}{wxevthandler}\\ @@ -40,17 +39,22 @@ window class or on all platforms. \begin{twocollist}\itemsep=0pt \twocolitem{\windowstyle{wxSIMPLE\_BORDER}}{Displays a thin border around the window. wxBORDER is the old name for this style. } -\twocolitem{\windowstyle{wxDOUBLE\_BORDER}}{Displays a double border. Windows only.} +\twocolitem{\windowstyle{wxDOUBLE\_BORDER}}{Displays a double border. Windows and Mac only.} \twocolitem{\windowstyle{wxSUNKEN\_BORDER}}{Displays a sunken border.} -\twocolitem{\windowstyle{wxRAISED\_BORDER}}{Displays a raised border. GTK only. } +\twocolitem{\windowstyle{wxRAISED\_BORDER}}{Displays a raised border.} \twocolitem{\windowstyle{wxSTATIC\_BORDER}}{Displays a border suitable for a static control. Windows only. } +\twocolitem{\windowstyle{wxNO\_BORDER}}{Displays no border, overriding the default border style for the window.} \twocolitem{\windowstyle{wxTRANSPARENT\_WINDOW}}{The window is transparent, that is, it will not receive paint events. Windows only.} \twocolitem{\windowstyle{wxTAB\_TRAVERSAL}}{Use this to enable tab traversal for non-dialog windows.} -\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{wxWANTS\_CHARS}}{Use this to indicate that +the window wants to get all char/key events for all keys - even for +keys like TAB or ENTER which are usually used for dialog navigation +and which wouldn't be generated without this style. If you need to +use this style in order to get the arrows or etc., but would still like to have +normal keyboard navigation take place, you should create and send a +wxNavigationKeyEvent in response to the key events for Tab and +Shift-Tab.} \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 this style. Currently only has an effect for @@ -369,7 +373,6 @@ 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: @@ -418,15 +421,12 @@ 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 +\pythonnote{In place of a single overloaded method name, wxPythonimplements 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} @@ -496,6 +496,7 @@ void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event) \end{verbatim} + \membersection{wxWindow::DragAcceptFiles}\label{wxwindowdragacceptfiles} \func{virtual void}{DragAcceptFiles}{\param{bool}{ accept}} @@ -550,6 +551,7 @@ Note that this is a static function, so it can be called without needing a wxWin \helpref{wxWindow::SetFocus}{wxwindowsetfocus} + \membersection{wxWindow::FindWindow}\label{wxwindowfindwindow} \func{wxWindow*}{FindWindow}{\param{long}{ id}} @@ -649,7 +651,8 @@ subwindows. Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. \helpref{Thaw}{wxwindowthaw} must -be called to reenable window redrawing. +be called to reenable window redrawing. Calls to these two functions may be +nested. This method is useful for visual appearance optimization (for example, it is a good idea to use it before inserting large amount of text into a @@ -658,6 +661,13 @@ controls so it is mostly just a hint to wxWindows and not a mandatory directive. +\membersection{wxWindow::GetAcceleratorTable}\label{wxwindowgetacceleratortable} + +\constfunc{wxAcceleratorTable*}{GetAcceleratorTable}{\void} + +Gets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxacceleratortable}. + + \membersection{wxWindow::GetAccessible}\label{wxwindowgetaccessible} \func{wxAccessibile*}{GetAccessible}{\void} @@ -750,7 +760,7 @@ Returns a reference to the list of the window's children. \constfunc{void}{GetClientSize}{\param{int* }{width}, \param{int* }{height}} \perlnote{In wxPerl this method takes no parameter and returns -a 2-element list {\tt ( width, height )}.} +a 2-element list {\tt (width, height)}.} \constfunc{wxSize}{GetClientSize}{\void} @@ -774,10 +784,11 @@ implements the following methods:\par \wxheading{See also} -\helpref{GetSize}{wxwindowgetsize} +\helpref{GetSize}{wxwindowgetsize},\rtfsp \helpref{GetVirtualSize}{wxwindowgetvirtualsize} + \membersection{wxWindow::GetConstraints}\label{wxwindowgetconstraints} \constfunc{wxLayoutConstraints*}{GetConstraints}{\void} @@ -793,6 +804,17 @@ Return the sizer that this window is a member of, if any, otherwise {\tt NULL}. +\membersection{wxWindow::GetCursor}\label{wxwindowgetcursor} + +\constfunc{const wxCursor\&}{GetCursor}{\void} + +Return the cursor associated with this window. + +\wxheading{See also} + +\helpref{wxWindow::SetCursor}{wxwindowsetcursor} + + \membersection{wxWindow::GetDropTarget}\label{wxwindowgetdroptarget} \constfunc{wxDropTarget*}{GetDropTarget}{\void} @@ -1092,7 +1114,6 @@ window with the currently selected font. \docparam{use16}{If {\tt true}, {\it string} contains 16-bit characters. The default is {\tt false}.} - \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} @@ -1227,7 +1248,7 @@ only redrawing those areas, which have been exposed. \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{{\bf IsExposed(x,y, w=0,h=0}}{} +\twocolitem{{\bf IsExposed(x,y, w=0,h=0)}}{} \twocolitem{{\bf IsExposedPoint(pt)}}{} \twocolitem{{\bf IsExposedRect(rect)}}{} \end{twocollist}}} @@ -1294,8 +1315,7 @@ or frame). \func{virtual void}{MakeModal}{\param{bool }{flag}} Disables all other windows in the application so that -the user can only interact with this window. (This function -is not implemented anywhere). +the user can only interact with this window. \wxheading{Parameters} @@ -1963,7 +1983,7 @@ or frame). \func{virtual void}{Refresh}{\param{bool}{ eraseBackground = {\tt true}}, \param{const wxRect* }{rect = NULL}} -Causes a message or event to be generated to repaint the +Causes an event to be generated to repaint the window. \wxheading{Parameters} @@ -2355,6 +2375,7 @@ If the window already has a drop target, it is deleted. \helpref{Drag and drop overview}{wxdndoverview} + \membersection{wxWindow::SetEventHandler}\label{wxwindowseteventhandler} \func{void}{SetEventHandler}{\param{wxEvtHandler* }{handler}} @@ -2416,6 +2437,10 @@ you should use the style of {\tt wxDEFAULT\_FRAME\_STYLE \& \textasciitilde(wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the frames having this style (the dialogs don't have minimize nor maximize box by default)} +\twocolitem{\windowstyle{wxWS\_EX\_PROCESS\_IDLE}}{This window should always process idle events, even +if the mode set by \helpref{wxIdleEvent::SetMode}{wxidleeventsetmode} is wxIDLE\_PROCESS\_SPECIFIED.} +\twocolitem{\windowstyle{wxWS\_EX\_PROCESS\_UI\_UPDATES}}{This window should always process UI update events, +even if the mode set by \helpref{wxUpdateUIEvent::SetMode}{wxupdateuieventsetmode} is wxUPDATE\_UI\_PROCESS\_SPECIFIED.} \end{twocollist} @@ -2514,6 +2539,7 @@ on creation and should not be modified subsequently. \helpref{Window identifiers}{windowids} + \membersection{wxWindow::SetName}\label{wxwindowsetname} \func{virtual void}{SetName}{\param{const wxString\& }{name}} @@ -2588,6 +2614,7 @@ from your \helpref{wxSizeEvent}{wxsizeevent} handler function. \begin{comment} + \membersection{wxWindow::SetScrollPage}\label{wxwindowsetscrollpage} \func{virtual void}{SetScrollPage}{\param{int }{orientation}, \param{int }{pageSize}, \param{bool }{refresh = {\tt true}}} @@ -2655,6 +2682,7 @@ application to take note of scrollbar attributes and redraw contents accordingly \begin{comment} + \membersection{wxWindow::SetScrollRange}\label{wxwindowsetscrollrange} \func{virtual void}{SetScrollRange}{\param{int }{orientation}, \param{int }{range}, \param{bool }{refresh = {\tt true}}} @@ -2932,6 +2960,7 @@ See \helpref{Window styles}{windowstyles} for more information about flags. \helpref{GetWindowStyleFlag}{wxwindowgetwindowstyleflag} + \membersection{wxWindow::Show}\label{wxwindowshow} \func{virtual bool}{Show}{\param{bool}{ show = {\tt true}}} @@ -2954,12 +2983,14 @@ done because it already was in the requested state. \helpref{wxWindow::IsShown}{wxwindowisshown} + \membersection{wxWindow::Thaw}\label{wxwindowthaw} \func{virtual void}{Thaw}{\void} -Reenables window updating after a previous call to -\helpref{Freeze}{wxwindowfreeze}. +Reenables window updating after a previous call to +\helpref{Freeze}{wxwindowfreeze}. To really thaw the control, it must be called +exactly the same number of times as \helpref{Freeze}{wxwindowfreeze}. \membersection{wxWindow::TransferDataFromWindow}\label{wxwindowtransferdatafromwindow} @@ -3034,7 +3065,7 @@ window unconditionally. \membersection{wxWindow::UpdateWindowUI}\label{wxwindowupdatewindowui} -\func{virtual void}{UpdateWindowUI}{\param{long}{ flags = wxUPDATE_UI_NONE}} +\func{virtual void}{UpdateWindowUI}{\param{long}{ flags = wxUPDATE\_UI\_NONE}} This function sends \helpref{wxUpdateUIEvents}{wxupdateuievent} to the window. The particular implementation depends on the window; for