\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.
-
-%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.
+wxWindow is the base class for all windows and represents any visible objecto n
+screen. All controls, top level windows and so on are windows. Sizers and
+device contexts are not, however, as they don't appear on screen themselves.
+
+Please note that all children of the window will be deleted automatically by
+the destructor before the window itself is deleted which means that you don't
+have to worry about deleting them manually. Please see the \helpref{window
+deletion overview}{windowdeletionoverview} for more information.
+
+Also note that in this, and many others, wxWindows classes some
+\texttt{GetXXX()} methods may be overloaded (as, for example,
+\helpref{GetSize}{wxwindowgetsize} or
+\helpref{GetClientSize}{wxwindowgetclientsize}). In this case, the overloads
+are non-virtual because having multiple virtual functions with the same name
+results in a virtual function name hiding at the derived class level (in
+English, this means that the derived class has to override all overloaded
+variants if it overrides any of them). To allow overriding them in the derived
+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}
\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
nothing on the other platforms.}
\twocolitem{\windowstyle{wxCLIP\_CHILDREN}}{Use this style to eliminate flicker caused by the background being
repainted, then children being painted over them. Windows only.}
+\twocolitem{\windowstyle{wxFULL\_REPAINT\_ON\_RESIZE}}{Use this style to force
+a complete redraw of the window whenever it is resized instead of redrawing
+just the part of the window affected by resizing. Note that this was the
+behaviour by default before 2.5.1 release and that if you experience redraw
+problems with the code which previously used to work you may want to try this.}
\end{twocollist}
See also \helpref{window styles overview}{windowstyles}.
\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxWindow::wxWindow}\label{wxwindowctor}
\func{}{wxWindow}{\void}
\docparam{name}{Window name.}
+
\membersection{wxWindow::\destruct{wxWindow}}
\func{}{\destruct{wxWindow}}{\void}
\helpref{wxWindow::Destroy}{wxwindowdestroy},\rtfsp
\helpref{wxCloseEvent}{wxcloseevent}
+
\membersection{wxWindow::AddChild}
\func{virtual void}{AddChild}{\param{wxWindow* }{child}}
Adds a child window. This is called automatically by window creation
functions so should not be required by the application programmer.
+Notice that this function is mostly internal to wxWindows and shouldn't be
+called by the user code.
+
\wxheading{Parameters}
\docparam{child}{Child window to add.}
+
\membersection{wxWindow::CaptureMouse}\label{wxwindowcapturemouse}
\func{virtual void}{CaptureMouse}{\void}
\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}
+
\membersection{wxWindow::Center}\label{wxwindowcenter}
\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::CenterOnScreen}\label{wxwindowcenteronscreen}
\func{void}{CenterOnScreen}{\param{int}{ direction}}
A synonym for \helpref{CentreOnScreen}{wxwindowcentreonscreen}.
+
\membersection{wxWindow::Centre}\label{wxwindowcentre}
\func{void}{Centre}{\param{int}{ direction = wxBOTH}}
\helpref{wxWindow::Center}{wxwindowcenter}
+
\membersection{wxWindow::CentreOnParent}\label{wxwindowcentreonparent}
\func{void}{CentreOnParent}{\param{int}{ direction = wxBOTH}}
\helpref{wxWindow::CentreOnScreen}{wxwindowcenteronscreen}
+
\membersection{wxWindow::CentreOnScreen}\label{wxwindowcentreonscreen}
\func{void}{CentreOnScreen}{\param{int}{ direction = wxBOTH}}
\helpref{wxWindow::CentreOnParent}{wxwindowcenteronparent}
-\membersection{wxWindow::Clear}\label{wxwindowclear}
-\func{void}{Clear}{\void}
+\membersection{wxWindow::ClearBackground}\label{wxwindowclearbackground}
+
+\func{void}{ClearBackground}{\void}
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}}
\end{twocollist}}
}
+
\membersection{wxWindow::Close}\label{wxwindowclose}
\func{bool}{Close}{\param{bool}{ force = {\tt false}}}
\helpref{wxWindow::Destroy}{wxwindowdestroy},\rtfsp
\helpref{wxCloseEvent}{wxcloseevent}
+
\membersection{wxWindow::ConvertDialogToPixels}\label{wxwindowconvertdialogtopixels}
\func{wxPoint}{ConvertDialogToPixels}{\param{const wxPoint\&}{ pt}}
\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:
}
+
\membersection{wxWindow::ConvertPixelsToDialog}\label{wxwindowconvertpixelstodialog}
\func{wxPoint}{ConvertPixelsToDialog}{\param{const wxPoint\&}{ pt}}
\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}
\end{twocollist}}
}
+
\membersection{wxWindow::Destroy}\label{wxwindowdestroy}
\func{virtual bool}{Destroy}{\void}
{\tt true} if the window has either been successfully deleted, or it has been added
to the list of windows pending real deletion.
+
\membersection{wxWindow::DestroyChildren}
\func{virtual void}{DestroyChildren}{\void}
Destroys all children of a window. Called automatically by the destructor.
+
\membersection{wxWindow::Disable}\label{wxwindowdisable}
-\func{void}{Disable}{\void}
+\func{bool}{Disable}{\void}
Disables the window, same as \helpref{Enable({\tt false})}{wxwindowenable}.
Returns {\tt true} if the window has been disabled, {\tt false} if it had been
already disabled before the call to this function.
+
\membersection{wxWindow::DoUpdateWindowUI}\label{wxwindowdoupdatewindowui}
\func{virtual void}{DoUpdateWindowUI}{\param{wxUpdateUIEvent\&}{ event}}
}
\end{verbatim}
+
+
\membersection{wxWindow::DragAcceptFiles}\label{wxwindowdragacceptfiles}
\func{virtual void}{DragAcceptFiles}{\param{bool}{ accept}}
Windows only.
+
\membersection{wxWindow::Enable}\label{wxwindowenable}
\func{virtual bool}{Enable}{\param{bool}{ enable = {\tt true}}}
\helpref{wxWindow::IsEnabled}{wxwindowisenabled},\rtfsp
\helpref{wxWindow::Disable}{wxwindowdisable}
+
\membersection{wxWindow::FindFocus}\label{wxwindowfindfocus}
\func{static wxWindow*}{FindFocus}{\void}
\helpref{wxWindow::SetFocus}{wxwindowsetfocus}
+
+
\membersection{wxWindow::FindWindow}\label{wxwindowfindwindow}
\func{wxWindow*}{FindWindow}{\param{long}{ id}}
\end{twocollist}}
}
+
\membersection{wxWindow::FindWindowById}\label{wxwindowfindwindowbyid}
\func{static wxWindow*}{FindWindowById}{\param{long}{ id}, \param{wxWindow*}{ parent = NULL}}
\helpref{FindWindow}{wxwindowfindwindow}
+
\membersection{wxWindow::FindWindowByName}\label{wxwindowfindwindowbyname}
\func{static wxWindow*}{FindWindowByName}{\param{const wxString\&}{ name}, \param{wxWindow*}{ parent = NULL}}
\helpref{FindWindow}{wxwindowfindwindow}
+
\membersection{wxWindow::FindWindowByLabel}\label{wxwindowfindwindowbylabel}
\func{static wxWindow*}{FindWindowByLabel}{\param{const wxString\&}{ label}, \param{wxWindow*}{ parent = NULL}}
\helpref{FindWindow}{wxwindowfindwindow}
+
\membersection{wxWindow::Fit}\label{wxwindowfit}
\func{virtual void}{Fit}{\void}
instead of calling Fit.
+
\membersection{wxWindow::FitInside}\label{wxwindowfitinside}
\func{virtual void}{FitInside}{\void}
an interior sizer. This function similarly won't do anything if there are no
subwindows.
+
\membersection{wxWindow::Freeze}\label{wxwindowfreeze}
\func{virtual void}{Freeze}{\void}
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
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}
See also \helpref{wxAccessible}{wxaccessible}.
+
\membersection{wxWindow::GetAdjustedBestSize}\label{wxwindowgetadjustedbestsize}
\constfunc{wxSize}{GetAdjustedBestSize}{\void}
specified minimum size. ie. it is the minimum size the window should currently
be drawn at, not the minimal size it can possibly tolerate.
+
\membersection{wxWindow::GetBackgroundColour}\label{wxwindowgetbackgroundcolour}
\constfunc{virtual wxColour}{GetBackgroundColour}{\void}
\helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp
\helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour}
+
\membersection{wxWindow::GetBestSize}\label{wxwindowgetbestsize}
-\constfunc{virtual wxSize}{GetBestSize}{\void}
+\constfunc{wxSize}{GetBestSize}{\void}
This functions returns the best acceptable minimal size for the window. For
example, for a static control, it will be the minimal size such that the
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::GetCapture}\label{wxwindowgetcapture}
\func{static wxWindow *}{GetCapture}{\void}
\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse},
\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
+
\membersection{wxWindow::GetCharHeight}
\constfunc{virtual int}{GetCharHeight}{\void}
Returns the character height for this window.
+
\membersection{wxWindow::GetCharWidth}
\constfunc{virtual int}{GetCharWidth}{\void}
Returns the average character width for this window.
+
\membersection{wxWindow::GetChildren}
\func{wxList\&}{GetChildren}{\void}
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{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{virtual wxSize}{GetClientSize}{\void}
+\constfunc{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,
\wxheading{See also}
-\helpref{GetSize}{wxwindowgetsize}
+\helpref{GetSize}{wxwindowgetsize},\rtfsp
\helpref{GetVirtualSize}{wxwindowgetvirtualsize}
+
+
\membersection{wxWindow::GetConstraints}\label{wxwindowgetconstraints}
\constfunc{wxLayoutConstraints*}{GetConstraints}{\void}
Returns a pointer to the window's layout constraints, or NULL if there are none.
+
\membersection{wxWindow::GetContainingSizer}\label{wxwindowgetcontainingsizer}
\constfunc{const wxSizer *}{GetContainingSizer}{\void}
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}
\helpref{wxWindow::SetDropTarget}{wxwindowsetdroptarget},
\helpref{Drag and drop overview}{wxdndoverview}
+
\membersection{wxWindow::GetEventHandler}\label{wxwindowgeteventhandler}
\constfunc{wxEvtHandler*}{GetEventHandler}{\void}
\helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp
\helpref{wxEvtHandler}{wxevthandler}\rtfsp
+
\membersection{wxWindow::GetExtraStyle}\label{wxwindowgetextrastyle}
\constfunc{long}{GetExtraStyle}{\void}
Returns the extra style bits for the window.
+
\membersection{wxWindow::GetFont}\label{wxwindowgetfont}
\constfunc{wxFont\&}{GetFont}{\void}
\helpref{wxWindow::SetFont}{wxwindowsetfont}
+
\membersection{wxWindow::GetForegroundColour}\label{wxwindowgetforegroundcolour}
\func{virtual wxColour}{GetForegroundColour}{\void}
\helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
\helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour}
+
\membersection{wxWindow::GetGrandParent}
\constfunc{wxWindow*}{GetGrandParent}{\void}
Returns the grandparent of a window, or NULL if there isn't one.
+
\membersection{wxWindow::GetHandle}\label{wxwindowgethandle}
\constfunc{void*}{GetHandle}{\void}
\perlnote{This method will return an integer in wxPerl.}
+
\membersection{wxWindow::GetHelpText}\label{wxwindowgethelptext}
\constfunc{virtual wxString}{GetHelpText}{\void}
\helpref{SetHelpText}{wxwindowsethelptext}, \helpref{wxHelpProvider}{wxhelpprovider}
+
\membersection{wxWindow::GetId}\label{wxwindowgetid}
\constfunc{int}{GetId}{\void}
\helpref{wxWindow::SetId}{wxwindowsetid},\rtfsp
\helpref{Window identifiers}{windowids}
+
\membersection{wxWindow::GetLabel}
\constfunc{virtual wxString }{GetLabel}{\void}
tools or special-needs access programs) which need to identify windows
by name.
+
\membersection{wxWindow::GetName}\label{wxwindowgetname}
\constfunc{virtual wxString }{GetName}{\void}
\helpref{wxWindow::SetName}{wxwindowsetname}
+
\membersection{wxWindow::GetParent}
\constfunc{virtual wxWindow*}{GetParent}{\void}
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}}
\end{twocollist}
}}
+
\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::GetScrollThumb}\label{wxwindowgetscrollthumb}
\func{virtual int}{GetScrollThumb}{\param{int }{orientation}}
\helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
+
\membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos}
\func{virtual int}{GetScrollPos}{\param{int }{orientation}}
See \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
+
\membersection{wxWindow::GetScrollRange}\label{wxwindowgetscrollrange}
\func{virtual int}{GetScrollRange}{\param{int }{orientation}}
\helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
+
\membersection{wxWindow::GetSize}\label{wxwindowgetsize}
-\constfunc{virtual void}{GetSize}{\param{int* }{width}, \param{int* }{height}}
+\constfunc{void}{GetSize}{\param{int* }{width}, \param{int* }{height}}
-\constfunc{virtual wxSize}{GetSize}{\void}
+\constfunc{wxSize}{GetSize}{\void}
This gets the size of the entire window in pixels,
including title bar, border, scrollbars, etc.
\helpref{GetClientSize}{wxwindowgetclientsize},\rtfsp
\helpref{GetVirtualSize}{wxwindowgetvirtualsize}
+
\membersection{wxWindow::GetSizer}\label{wxwindowgetsizer}
\constfunc{wxSizer *}{GetSizer}{\void}
Return the sizer associated with the window by a previous call to
\helpref{SetSizer()}{wxwindowsetsizer} or {\tt NULL}.
+
\membersection{wxWindow::GetTextExtent}\label{wxwindowgettextextent}
\constfunc{virtual void}{GetTextExtent}{\param{const wxString\& }{string}, \param{int* }{x}, \param{int* }{y},
\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}
{\tt font} parameters, and returns a 4-element list
{\tt ( x, y, descent, externalLeading )}.}
+
\membersection{wxWindow::GetTitle}\label{wxwindowgettitle}
\func{virtual wxString}{GetTitle}{\void}
\helpref{wxWindow::SetTitle}{wxwindowsettitle}
+
\membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip}
\constfunc{wxToolTip*}{GetToolTip}{\void}
Get the associated tooltip or NULL if none.
+
\membersection{wxWindow::GetUpdateRegion}\label{wxwindowgetupdateregion}
\constfunc{virtual wxRegion}{GetUpdateRegion}{\void}
\helpref{wxRegion}{wxregion},\rtfsp
\helpref{wxRegionIterator}{wxregioniterator}
+
\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::GetVirtualSize}\label{wxwindowgetvirtualsize}
\constfunc{void}{GetVirtualSize}{\param{int* }{width}, \param{int* }{height}}
\helpref{GetSize}{wxwindowgetsize},\rtfsp
\helpref{GetClientSize}{wxwindowgetclientsize}
+
\membersection{wxWindow::GetWindowStyleFlag}\label{wxwindowgetwindowstyleflag}
\constfunc{long}{GetWindowStyleFlag}{\void}
Gets the window style that was passed to the constructor or {\bf Create}
method. {\bf GetWindowStyle()} is another name for the same function.
+
\membersection{wxWindow::HasCapture}\label{wxwindowhascapture}
\constfunc{virtual bool}{HasCapture}{\void}
\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse},
\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
+
\membersection{wxWindow::Hide}\label{wxwindowhide}
\func{bool}{Hide}{\void}
Equivalent to calling \helpref{Show}{wxwindowshow}({\tt false}).
+
\membersection{wxWindow::InitDialog}\label{wxwindowinitdialog}
\func{void}{InitDialog}{\void}
Sends an {\tt wxEVT\_INIT\_DIALOG} event, whose handler usually transfers data
to the dialog via validators.
+
\membersection{wxWindow::IsEnabled}\label{wxwindowisenabled}
\constfunc{virtual bool}{IsEnabled}{\void}
\helpref{wxWindow::Enable}{wxwindowenable}
+
\membersection{wxWindow::IsExposed}\label{wxwindowisexposed}
\constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}}
\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}}}
+
\membersection{wxWindow::IsRetained}\label{wxwindowisretained}
\constfunc{virtual bool}{IsRetained}{\void}
Retained windows are only available on X platforms.
+
\membersection{wxWindow::IsShown}\label{wxwindowisshown}
\constfunc{virtual bool}{IsShown}{\void}
Returns {\tt true} if the window is shown, {\tt false} if it has been hidden.
+
\membersection{wxWindow::IsTopLevel}\label{wxwindowistoplevel}
\constfunc{bool}{IsTopLevel}{\void}
dialogs are considered to be top-level windows (even if they have a parent
window).
+
\membersection{wxWindow::Layout}\label{wxwindowlayout}
\func{void}{Layout}{\void}
See \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout}: when auto
layout is on, this function gets called automatically when the window is resized.
+
\membersection{wxWindow::LineDown}\label{wxwindowlinedown}
This is just a wrapper for \helpref{ScrollLines()}{wxwindowscrolllines}$(1)$.
+
\membersection{wxWindow::LineUp}\label{wxwindowlineup}
This is just a wrapper for \helpref{ScrollLines()}{wxwindowscrolllines}$(-1)$.
+
\membersection{wxWindow::Lower}\label{wxwindowlower}
\func{void}{Lower}{\void}
Lowers the window to the bottom of the window hierarchy if it is a managed window (dialog
or frame).
+
\membersection{wxWindow::MakeModal}\label{wxwindowmakemodal}
\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}
\docparam{flag}{If {\tt true}, this call disables all other windows in the application so that
the user can only interact with this window. If {\tt false}, the effect is reversed.}
+
\membersection{wxWindow::Move}\label{wxwindowmove}
\func{void}{Move}{\param{int}{ x}, \param{int}{ y}}
%% \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent},\rtfsp
%% \helpref{Event handling overview}{eventhandlingoverview}
+
\membersection{wxWindow::OnInternalIdle}\label{wxwindowoninternalidle}
\func{virtual void}{OnInternalIdle}{\void}
and most implementations call \helpref{wxWindow::UpdateWindowUI}{wxwindowupdatewindowui}
in order to send update events to the window in idle time.
+
\membersection{wxWindow::PageDown}\label{wxwindowpagedown}
This is just a wrapper for \helpref{ScrollPages()}{wxwindowscrollpages}$(1)$.
+
\membersection{wxWindow::PageUp}\label{wxwindowpageup}
This is just a wrapper for \helpref{ScrollPages()}{wxwindowscrollpages}$(-1)$.
+
\membersection{wxWindow::PopEventHandler}\label{wxwindowpopeventhandler}
\constfunc{wxEvtHandler*}{PopEventHandler}{\param{bool }{deleteHandler = {\tt false}}}
\helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp
\helpref{wxEvtHandler}{wxevthandler}\rtfsp
+
\membersection{wxWindow::PopupMenu}\label{wxwindowpopupmenu}
\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const wxPoint\& }{pos}}
\end{twocollist}}
}
+
\membersection{wxWindow::PushEventHandler}\label{wxwindowpusheventhandler}
\func{void}{PushEventHandler}{\param{wxEvtHandler* }{handler}}
\helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp
\helpref{wxEvtHandler}{wxevthandler}
+
\membersection{wxWindow::Raise}\label{wxwindowraise}
\func{void}{Raise}{\void}
Raises the window to the top of the window hierarchy if it is a managed window (dialog
or frame).
+
\membersection{wxWindow::Refresh}\label{wxwindowrefresh}
\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}
\helpref{wxWindow::RefreshRect}{wxwindowrefreshrect}
+
\membersection{wxWindow::RefreshRect}\label{wxwindowrefreshrect}
-\func{virtual void}{Refresh}{\param{const wxRect\& }{rect}}
+\func{void}{Refresh}{\param{const wxRect\& }{rect}}
Redraws the contents of the given rectangle: the area inside it will be
repainted.
This is the same as \helpref{Refresh}{wxwindowrefresh} but has a nicer syntax.
+
+\membersection{wxWindow::RegisterHotKey}\label{wxwindowregisterhotkey}
+
+\func{bool}{RegisterHotKey}{\param{int}{ hotkeyId}, \param{int}{ modifiers}, \param{int}{ virtualKeyCode}}
+
+Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window
+will receive a hotkey event. It will receive the event even if the application is in the background
+and does not have the input focus because the user is working with some other application.
+
+\wxheading{Parameters}
+
+\docparam{hotkeyId}{Numeric identifier of the hotkey. For applications this must be between 0 and 0xBFFF. If
+this function is called from a shared DLL, it must be a system wide unique identifier between 0xC000 and 0xFFFF.
+This is a MSW specific detail.}
+
+\docparam{modifiers}{A bitwise combination of {\tt wxMOD\_SHIFT}, {\tt wxMOD\_CONTROL}, {\tt wxMOD\_ALT}
+or {\tt wxMOD\_WIN} specifying the modifier keys that have to be pressed along with the key.}
+
+\docparam{virtualKeyCode}{The virtual key code of the hotkey.}
+
+\wxheading{Return value}
+
+{\tt true} if the hotkey was registered successfully. {\tt false} if some other application already registered a
+hotkey with this modifier/virtualKeyCode combination.
+
+\wxheading{Remarks}
+
+Use EVT\_HOTKEY(hotkeyId, fnc) in the event table to capture the event.
+This function is currently only implemented under MSW.
+
+\wxheading{See also}
+
+\helpref{wxWindow::UnregisterHotKey}{wxwindowunregisterhotkey}
+
+
\membersection{wxWindow::ReleaseMouse}\label{wxwindowreleasemouse}
\func{virtual void}{ReleaseMouse}{\void}
\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse},
\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
+
\membersection{wxWindow::RemoveChild}\label{wxwindowremovechild}
\func{virtual void}{RemoveChild}{\param{wxWindow* }{child}}
Removes a child window. This is called automatically by window deletion
functions so should not be required by the application programmer.
+Notice that this function is mostly internal to wxWindows and shouldn't be
+called by the user code.
+
\wxheading{Parameters}
\docparam{child}{Child window to remove.}
+
\membersection{wxWindow::RemoveEventHandler}\label{wxwindowremoveeventhandler}
\func{bool}{RemoveEventHandler}{\param{wxEvtHandler *}{handler}}
\helpref{PushEventHandler}{wxwindowpusheventhandler},\rtfsp
\helpref{PopEventHandler}{wxwindowpopeventhandler}
+
\membersection{wxWindow::Reparent}\label{wxwindowreparent}
\func{virtual bool}{Reparent}{\param{wxWindow* }{newParent}}
\docparam{newParent}{New parent.}
+
\membersection{wxWindow::ScreenToClient}\label{wxwindowscreentoclient}
\constfunc{virtual void}{ScreenToClient}{\param{int* }{x}, \param{int* }{y}}
\end{twocollist}}
}
+
\membersection{wxWindow::ScrollLines}\label{wxwindowscrolllines}
\func{virtual bool}{ScrollLines}{\param{int }{lines}}
\helpref{ScrollPages}{wxwindowscrollpages}
+
\membersection{wxWindow::ScrollPages}\label{wxwindowscrollpages}
\func{virtual bool}{ScrollPages}{\param{int }{pages}}
\helpref{ScrollLines}{wxwindowscrolllines}
+
\membersection{wxWindow::ScrollWindow}\label{wxwindowscrollwindow}
\func{virtual void}{ScrollWindow}{\param{int }{dx}, \param{int }{dy}, \param{const wxRect*}{ rect = NULL}}
Use this function to optimise your scrolling implementations, to minimise the area that must be
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::SetAccessible}\label{wxwindowsetaccessible}
\func{void}{SetAccessible}{\param{wxAccessibile*}{ accessible}}
See also \helpref{wxAccessible}{wxaccessible}.
+
\membersection{wxWindow::SetAutoLayout}\label{wxwindowsetautolayout}
\func{void}{SetAutoLayout}{\param{bool}{ autoLayout}}
\helpref{wxWindow::SetConstraints}{wxwindowsetconstraints}
+
\membersection{wxWindow::SetBackgroundColour}\label{wxwindowsetbackgroundcolour}
\func{virtual void}{SetBackgroundColour}{\param{const wxColour\& }{colour}}
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
+may wish to call \helpref{wxWindow::ClearBackground}{wxwindowclearbackground} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after
calling this function.
-Use this function with care under GTK as the new appearance of the window might
-not look equally well when used with "Themes", i.e GTK's ability to change its
+Use this function with care under GTK+ as the new appearance of the window might
+not look equally well when used with "Themes", i.e GTK+'s ability to change its
look as the user wishes with run-time loadable modules.
\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::ClearBackground}{wxwindowclearbackground},\rtfsp
\helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp
\helpref{wxEraseEvent}{wxeraseevent}
+
\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}}
\end{twocollist}}
}
+
\membersection{wxWindow::SetContainingSizer}\label{wxwindowsetcontainingsizer}
\func{void}{SetContainingSizer}{\param{wxSizer* }{sizer}}
when a window is added to a sizer, and is used so the window can
remove itself from the sizer when it is destroyed.
+
\membersection{wxWindow::SetCursor}\label{wxwindowsetcursor}
\func{virtual void}{SetCursor}{\param{const wxCursor\&}{cursor}}
\helpref{::wxSetCursor}{wxsetcursor}, \helpref{wxCursor}{wxcursor}
+
\membersection{wxWindow::SetConstraints}\label{wxwindowsetconstraints}
\func{void}{SetConstraints}{\param{wxLayoutConstraints* }{constraints}}
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}}
\helpref{wxWindow::GetDropTarget}{wxwindowgetdroptarget},
\helpref{Drag and drop overview}{wxdndoverview}
+
+
\membersection{wxWindow::SetEventHandler}\label{wxwindowseteventhandler}
\func{void}{SetEventHandler}{\param{wxEvtHandler* }{handler}}
\helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp
\helpref{wxEvtHandler}{wxevthandler}
+
\membersection{wxWindow::SetExtraStyle}\label{wxwindowsetextrastyle}
\func{void}{SetExtraStyle}{\param{long }{exStyle}}
{\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}
+
\membersection{wxWindow::SetFocus}\label{wxwindowsetfocus}
\func{virtual void}{SetFocus}{\void}
\helpref{wxFocusEvent}{wxfocusevent}
+
\membersection{wxWindow::SetFocusFromKbd}\label{wxwindowsetfocusfromkbd}
\func{virtual void}{SetFocusFromKbd}{\void}
By default this method simply calls \helpref{SetFocus}{wxwindowsetfocus} but
can be overridden to do something in addition to this in the derived classes.
+
\membersection{wxWindow::SetFont}\label{wxwindowsetfont}
\func{void}{SetFont}{\param{const wxFont\& }{font}}
\helpref{wxWindow::GetFont}{wxwindowgetfont}
+
\membersection{wxWindow::SetForegroundColour}\label{wxwindowsetforegroundcolour}
\func{virtual void}{SetForegroundColour}{\param{const wxColour\& }{colour}}
\helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
\helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour}
+
\membersection{wxWindow::SetHelpText}\label{wxwindowsethelptext}
\func{virtual void}{SetHelpText}{\param{const wxString\& }{helpText}}
\helpref{GetHelpText}{wxwindowgethelptext}, \helpref{wxHelpProvider}{wxhelpprovider}
+
\membersection{wxWindow::SetId}\label{wxwindowsetid}
\func{void}{SetId}{\param{int}{ id}}
\helpref{wxWindow::GetId}{wxwindowgetid},\rtfsp
\helpref{Window identifiers}{windowids}
+
+
\membersection{wxWindow::SetName}\label{wxwindowsetname}
\func{virtual void}{SetName}{\param{const wxString\& }{name}}
\helpref{wxWindow::GetName}{wxwindowgetname}
+
\membersection{wxWindow::SetPalette}\label{wxwindowsetpalette}
\func{virtual void}{SetPalette}{\param{wxPalette* }{palette}}
Obsolete - use \helpref{wxDC::SetPalette}{wxdcsetpalette} instead.
+
\membersection{wxWindow::SetScrollbar}\label{wxwindowsetscrollbar}
\func{virtual void}{SetScrollbar}{\param{int }{orientation}, \param{int }{position},\rtfsp
\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
\begin{comment}
+
+
\membersection{wxWindow::SetScrollPage}\label{wxwindowsetscrollpage}
\func{virtual void}{SetScrollPage}{\param{int }{orientation}, \param{int }{pageSize}, \param{bool }{refresh = {\tt true}}}
\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
\end{comment}
+
\membersection{wxWindow::SetScrollPos}\label{wxwindowsetscrollpos}
\func{virtual void}{SetScrollPos}{\param{int }{orientation}, \param{int }{pos}, \param{bool }{refresh = {\tt true}}}
\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
\begin{comment}
+
+
\membersection{wxWindow::SetScrollRange}\label{wxwindowsetscrollrange}
\func{virtual void}{SetScrollRange}{\param{int }{orientation}, \param{int }{range}, \param{bool }{refresh = {\tt true}}}
\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
\end{comment}
+
\membersection{wxWindow::SetSize}\label{wxwindowsetsize}
\func{virtual void}{SetSize}{\param{int}{ x}, \param{int}{ y}, \param{int}{ width}, \param{int}{ height},
\end{twocollist}}
}
+
\membersection{wxWindow::SetSizeHints}\label{wxwindowsetsizehints}
\func{virtual void}{SetSizeHints}{\param{int}{ minW=-1}, \param{int}{ minH=-1}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1},
The resizing increments are only significant under Motif or Xt.
+
\membersection{wxWindow::SetSizer}\label{wxwindowsetsizer}
\func{void}{SetSizer}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=true}}
explicitly. When setting both a wxSizer and a \helpref{wxLayoutConstraints}{wxlayoutconstraints},
only the sizer will have effect.
+
\membersection{wxWindow::SetSizerAndFit}\label{wxwindowsetsizerandfit}
\func{void}{SetSizerAndFit}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=true}}
The same as \helpref{SetSizer}{wxwindowsetsizer}, except it also sets the size hints
for the window based on the sizer's minimum size.
+
\membersection{wxWindow::SetTitle}\label{wxwindowsettitle}
\func{virtual void}{SetTitle}{\param{const wxString\& }{title}}
\helpref{wxWindow::GetTitle}{wxwindowgettitle}
+
\membersection{wxWindow::SetThemeEnabled}\label{wxwindowsetthemeenabled}
\func{virtual void}{SetThemeEnabled}{\param{bool }{enable}}
Dialogs, notebook pages and the status bar have this flag set to true
by default so that the default look and feel is simulated best.
+
\membersection{wxWindow::SetToolTip}\label{wxwindowsettooltip}
\func{void}{SetToolTip}{\param{const wxString\& }{tip}}
See also: \helpref{GetToolTip}{wxwindowgettooltip},
\helpref{wxToolTip}{wxtooltip}
+
\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::SetVirtualSize}\label{wxwindowsetvirtualsize}
\func{void}{SetVirtualSize}{\param{int}{ width}, \param{int}{ height}}
Sets the virtual size of the window in pixels.
+
\membersection{wxWindow::SetVirtualSizeHints}\label{wxwindowsetvirtualsizehints}
\func{virtual void}{SetVirtualSizeHints}{\param{int}{ minW},\param{int}{ minH}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}}
If this function is called, the user will not be able to size the virtual area
of the window outside the given bounds.
+
\membersection{wxWindow::SetWindowStyle}\label{wxwindowsetwindowstyle}
\func{void}{SetWindowStyle}{\param{long}{ style}}
Identical to \helpref{SetWindowStyleFlag}{wxwindowsetwindowstyleflag}.
+
\membersection{wxWindow::SetWindowStyleFlag}\label{wxwindowsetwindowstyleflag}
\func{virtual void}{SetWindowStyleFlag}{\param{long}{ style}}
\helpref{GetWindowStyleFlag}{wxwindowgetwindowstyleflag}
+
+
\membersection{wxWindow::Show}\label{wxwindowshow}
\func{virtual bool}{Show}{\param{bool}{ show = {\tt true}}}
\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}
\helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow},\rtfsp
\helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::Validate}{wxwindowvalidate}
+
\membersection{wxWindow::TransferDataToWindow}\label{wxwindowtransferdatatowindow}
\func{virtual bool}{TransferDataToWindow}{\void}
\helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
\helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::Validate}{wxwindowvalidate}
+
+\membersection{wxWindow::UnregisterHotKey}\label{wxwindowunregisterhotkey}
+
+\func{bool}{UnregisterHotKey}{\param{int}{ hotkeyId}}
+
+Unregisters a system wide hotkey.
+
+\wxheading{Parameters}
+
+\docparam{hotkeyId}{Numeric identifier of the hotkey. Must be the same id that was passed to RegisterHotKey.}
+
+\wxheading{Return value}
+
+{\tt true} if the hotkey was unregistered successfully, {\tt false} if the id was invalid.
+
+\wxheading{Remarks}
+
+This function is currently only implemented under MSW.
+
+\wxheading{See also}
+
+\helpref{wxWindow::RegisterHotKey}{wxwindowregisterhotkey}
+
+
\membersection{wxWindow::Update}\label{wxwindowupdate}
\func{virtual void}{Update}{\void}
\helpref{Refresh}{wxwindowrefresh} first if you want to immediately redraw the
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
\helpref{wxWindow::DoUpdateWindowUI}{wxwindowdoupdatewindowui},
\helpref{wxWindow::OnInternalIdle}{wxwindowoninternalidle}
+
\membersection{wxWindow::Validate}\label{wxwindowvalidate}
\func{virtual bool}{Validate}{\void}
\helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
\helpref{wxValidator}{wxvalidator}
+
\membersection{wxWindow::WarpPointer}\label{wxwindowwarppointer}
\func{void}{WarpPointer}{\param{int}{ x}, \param{int}{ y}}
projects / wxWidgets.git / blobdiff