1999-05-09 18:17:03 -04:00
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
2001-12-07 19:26:30 -05:00
|
|
|
// Name: wx/window.h
|
1999-05-23 19:48:12 -04:00
|
|
|
// Purpose: wxWindowBase class - the interface of wxWindow
|
1999-05-09 18:17:03 -04:00
|
|
|
// Author: Vadim Zeitlin
|
2002-04-19 18:12:38 -04:00
|
|
|
// Modified by: Ron Lee
|
1999-05-09 18:17:03 -04:00
|
|
|
// Created: 01/02/97
|
|
|
|
// RCS-ID: $Id$
|
|
|
|
// Copyright: (c) wxWindows team
|
|
|
|
// Licence: wxWindows licence
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
1998-08-14 20:23:28 -04:00
|
|
|
#ifndef _WX_WINDOW_H_BASE_
|
|
|
|
#define _WX_WINDOW_H_BASE_
|
1998-05-20 10:01:55 -04:00
|
|
|
|
2002-08-31 07:29:13 -04:00
|
|
|
#if defined(__GNUG__) && !defined(__APPLE__)
|
1999-05-11 10:47:05 -04:00
|
|
|
#pragma interface "windowbase.h"
|
|
|
|
#endif
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// headers which we must include here
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
#include "wx/event.h" // the base class
|
|
|
|
|
|
|
|
#include "wx/list.h" // defines wxWindowList
|
|
|
|
|
|
|
|
#include "wx/cursor.h" // we have member variables of these classes
|
|
|
|
#include "wx/font.h" // so we can't do without them
|
|
|
|
#include "wx/colour.h"
|
|
|
|
#include "wx/region.h"
|
1999-10-10 11:04:47 -04:00
|
|
|
#include "wx/utils.h"
|
1999-06-01 11:32:12 -04:00
|
|
|
|
2000-01-06 11:47:48 -05:00
|
|
|
#include "wx/validate.h" // for wxDefaultValidator (always include it)
|
1999-07-26 19:02:32 -04:00
|
|
|
|
2002-02-07 13:46:31 -05:00
|
|
|
#if wxUSE_PALETTE
|
2002-04-20 20:31:35 -04:00
|
|
|
#include "wx/dcclient.h"
|
|
|
|
#include "wx/palette.h"
|
2002-02-07 13:46:31 -05:00
|
|
|
#endif // wxUSE_PALETTE
|
|
|
|
|
1999-06-01 11:32:12 -04:00
|
|
|
#if wxUSE_ACCEL
|
|
|
|
#include "wx/accel.h"
|
|
|
|
#endif // wxUSE_ACCEL
|
1999-05-09 18:17:03 -04:00
|
|
|
|
2001-07-10 08:25:46 -04:00
|
|
|
// when building wxUniv/Foo we don't want the code for native menu use to be
|
|
|
|
// compiled in - it should only be used when building real wxFoo
|
|
|
|
#ifdef __WXUNIVERSAL__
|
|
|
|
#define wxUSE_MENUS_NATIVE 0
|
|
|
|
#else // __WXMSW__
|
|
|
|
#define wxUSE_MENUS_NATIVE wxUSE_MENUS
|
|
|
|
#endif // __WXUNIVERSAL__/__WXMSW__
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// forward declarations
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
1999-05-23 19:48:12 -04:00
|
|
|
class WXDLLEXPORT wxCaret;
|
1999-05-09 18:17:03 -04:00
|
|
|
class WXDLLEXPORT wxControl;
|
|
|
|
class WXDLLEXPORT wxCursor;
|
1999-05-11 14:28:37 -04:00
|
|
|
class WXDLLEXPORT wxDC;
|
1999-05-09 18:17:03 -04:00
|
|
|
class WXDLLEXPORT wxDropTarget;
|
|
|
|
class WXDLLEXPORT wxItemResource;
|
|
|
|
class WXDLLEXPORT wxLayoutConstraints;
|
|
|
|
class WXDLLEXPORT wxResourceTable;
|
|
|
|
class WXDLLEXPORT wxSizer;
|
|
|
|
class WXDLLEXPORT wxToolTip;
|
|
|
|
class WXDLLEXPORT wxWindowBase;
|
|
|
|
class WXDLLEXPORT wxWindow;
|
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// (pseudo)template list classes
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode, class WXDLLEXPORT);
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// global variables
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
WXDLLEXPORT_DATA(extern wxWindowList) wxTopLevelWindows;
|
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxWindowBase is the base class for all GUI controls/widgets, this is the public
|
|
|
|
// interface of this class.
|
|
|
|
//
|
|
|
|
// Event handler: windows have themselves as their event handlers by default,
|
|
|
|
// but their event handlers could be set to another object entirely. This
|
|
|
|
// separation can reduce the amount of derivation required, and allow
|
|
|
|
// alteration of a window's functionality (e.g. by a resource editor that
|
|
|
|
// temporarily switches event handlers).
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class WXDLLEXPORT wxWindowBase : public wxEvtHandler
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
// creating the window
|
|
|
|
// -------------------
|
|
|
|
|
|
|
|
// default ctor
|
|
|
|
wxWindowBase() { InitBase(); }
|
|
|
|
|
|
|
|
// pseudo ctor (can't be virtual, called from ctor)
|
|
|
|
bool CreateBase(wxWindowBase *parent,
|
|
|
|
wxWindowID id,
|
|
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
|
|
const wxSize& size = wxDefaultSize,
|
|
|
|
long style = 0,
|
1999-07-26 19:02:32 -04:00
|
|
|
const wxValidator& validator = wxDefaultValidator,
|
1999-05-09 18:17:03 -04:00
|
|
|
const wxString& name = wxPanelNameStr);
|
|
|
|
|
|
|
|
virtual ~wxWindowBase();
|
|
|
|
|
|
|
|
#if wxUSE_WX_RESOURCES
|
|
|
|
// these functions are implemented in resource.cpp and resourc2.cpp
|
|
|
|
virtual bool LoadFromResource(wxWindow *parent,
|
|
|
|
const wxString& resourceName,
|
|
|
|
const wxResourceTable *table = (const wxResourceTable *) NULL);
|
|
|
|
virtual wxControl *CreateItem(const wxItemResource* childResource,
|
|
|
|
const wxItemResource* parentResource,
|
|
|
|
const wxResourceTable *table = (const wxResourceTable *) NULL);
|
|
|
|
#endif // wxUSE_WX_RESOURCES
|
|
|
|
|
|
|
|
// deleting the window
|
|
|
|
// -------------------
|
|
|
|
|
|
|
|
// ask the window to close itself, return TRUE if the event handler
|
|
|
|
// honoured our request
|
|
|
|
bool Close( bool force = FALSE );
|
|
|
|
|
|
|
|
// the following functions delete the C++ objects (the window itself
|
|
|
|
// or its children) as well as the GUI windows and normally should
|
|
|
|
// never be used directly
|
|
|
|
|
|
|
|
// delete window unconditionally (dangerous!), returns TRUE if ok
|
|
|
|
virtual bool Destroy();
|
|
|
|
// delete all children of this window, returns TRUE if ok
|
|
|
|
bool DestroyChildren();
|
|
|
|
|
|
|
|
// is the window being deleted?
|
|
|
|
bool IsBeingDeleted() const { return m_isBeingDeleted; }
|
|
|
|
|
|
|
|
// window attributes
|
|
|
|
// -----------------
|
|
|
|
|
2001-08-05 20:49:59 -04:00
|
|
|
// NB: in future versions of wxWindows Set/GetTitle() will only work
|
|
|
|
// with the top level windows (such as dialogs and frames) and
|
|
|
|
// Set/GetLabel() only with the other ones (i.e. all controls).
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// the title (or label, see below) of the window: the text which the
|
|
|
|
// window shows
|
2001-08-04 18:36:19 -04:00
|
|
|
virtual void SetTitle( const wxString& WXUNUSED(title) ) {}
|
|
|
|
virtual wxString GetTitle() const { return wxEmptyString; }
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// label is just the same as the title (but for, e.g., buttons it
|
|
|
|
// makes more sense to speak about labels)
|
1999-05-21 09:28:49 -04:00
|
|
|
virtual void SetLabel(const wxString& label) { SetTitle(label); }
|
|
|
|
virtual wxString GetLabel() const { return GetTitle(); }
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// the window name is used for ressource setting in X, it is not the
|
|
|
|
// same as the window title/label
|
|
|
|
virtual void SetName( const wxString &name ) { m_windowName = name; }
|
|
|
|
virtual wxString GetName() const { return m_windowName; }
|
|
|
|
|
|
|
|
// window id uniquely identifies the window among its siblings unless
|
|
|
|
// it is -1 which means "don't care"
|
|
|
|
void SetId( wxWindowID id ) { m_windowId = id; }
|
|
|
|
wxWindowID GetId() const { return m_windowId; }
|
|
|
|
|
|
|
|
// generate a control id for the controls which were not given one by
|
|
|
|
// user
|
1999-05-12 18:12:18 -04:00
|
|
|
static int NewControlId() { return --ms_lastControlId; }
|
1999-05-17 10:51:52 -04:00
|
|
|
// get the id of the control following the one with the given
|
|
|
|
// (autogenerated) id
|
|
|
|
static int NextControlId(int id) { return id - 1; }
|
|
|
|
// get the id of the control preceding the one with the given
|
|
|
|
// (autogenerated) id
|
|
|
|
static int PrevControlId(int id) { return id + 1; }
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// moving/resizing
|
|
|
|
// ---------------
|
|
|
|
|
|
|
|
// set the window size and/or position
|
|
|
|
void SetSize( int x, int y, int width, int height,
|
|
|
|
int sizeFlags = wxSIZE_AUTO )
|
|
|
|
{ DoSetSize(x, y, width, height, sizeFlags); }
|
|
|
|
|
|
|
|
void SetSize( int width, int height )
|
|
|
|
{ DoSetSize( -1, -1, width, height, wxSIZE_USE_EXISTING ); }
|
|
|
|
|
|
|
|
void SetSize( const wxSize& size )
|
|
|
|
{ SetSize( size.x, size.y); }
|
|
|
|
|
|
|
|
void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO)
|
|
|
|
{ DoSetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); }
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
void Move(int x, int y, int flags = wxSIZE_USE_EXISTING)
|
|
|
|
{ DoSetSize(x, y, -1, -1, flags); }
|
1999-05-09 18:17:03 -04:00
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING)
|
|
|
|
{ Move(pt.x, pt.y, flags); }
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// Z-order
|
|
|
|
virtual void Raise() = 0;
|
|
|
|
virtual void Lower() = 0;
|
|
|
|
|
|
|
|
// client size is the size of area available for subwindows
|
|
|
|
void SetClientSize( int width, int height )
|
|
|
|
{ DoSetClientSize(width, height); }
|
|
|
|
|
|
|
|
void SetClientSize( const wxSize& size )
|
|
|
|
{ DoSetClientSize(size.x, size.y); }
|
|
|
|
|
|
|
|
void SetClientSize(const wxRect& rect)
|
|
|
|
{ SetClientSize( rect.width, rect.height ); }
|
|
|
|
|
|
|
|
// get the window position and/or size (pointers may be NULL)
|
|
|
|
void GetPosition( int *x, int *y ) const { DoGetPosition(x, y); }
|
|
|
|
wxPoint GetPosition() const
|
|
|
|
{
|
|
|
|
int w, h;
|
|
|
|
DoGetPosition(&w, &h);
|
|
|
|
|
|
|
|
return wxPoint(w, h);
|
|
|
|
}
|
|
|
|
|
|
|
|
void GetSize( int *w, int *h ) const { DoGetSize(w, h); }
|
|
|
|
wxSize GetSize() const
|
|
|
|
{
|
|
|
|
int w, h;
|
|
|
|
DoGetSize(& w, & h);
|
|
|
|
return wxSize(w, h);
|
|
|
|
}
|
|
|
|
|
|
|
|
wxRect GetRect() const
|
|
|
|
{
|
|
|
|
int x, y, w, h;
|
|
|
|
GetPosition(& x, & y);
|
|
|
|
GetSize(& w, & h);
|
|
|
|
|
|
|
|
return wxRect(x, y, w, h);
|
|
|
|
}
|
|
|
|
|
|
|
|
void GetClientSize( int *w, int *h ) const { DoGetClientSize(w, h); }
|
|
|
|
wxSize GetClientSize() const
|
|
|
|
{
|
|
|
|
int w, h;
|
|
|
|
DoGetClientSize(& w, & h);
|
|
|
|
|
|
|
|
return wxSize(w, h);
|
|
|
|
}
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// get the origin of the client area of the window relative to the
|
|
|
|
// window top left corner (the client area may be shifted because of
|
|
|
|
// the borders, scrollbars, other decorations...)
|
|
|
|
virtual wxPoint GetClientAreaOrigin() const;
|
|
|
|
|
|
|
|
// get the client rectangle in window (i.e. client) coordinates
|
|
|
|
wxRect GetClientRect() const
|
|
|
|
{
|
|
|
|
return wxRect(GetClientAreaOrigin(), GetClientSize());
|
|
|
|
}
|
|
|
|
|
1999-11-19 16:01:20 -05:00
|
|
|
// get the size best suited for the window (in fact, minimal
|
|
|
|
// acceptable size using which it will still look "nice")
|
|
|
|
wxSize GetBestSize() const { return DoGetBestSize(); }
|
|
|
|
void GetBestSize(int *w, int *h) const
|
|
|
|
{
|
|
|
|
wxSize s = DoGetBestSize();
|
|
|
|
if ( w )
|
|
|
|
*w = s.x;
|
|
|
|
if ( h )
|
|
|
|
*h = s.y;
|
|
|
|
}
|
|
|
|
|
2000-02-02 13:48:41 -05:00
|
|
|
// the generic centre function - centers the window on parent by
|
|
|
|
// default or on screen if it doesn't have parent or
|
|
|
|
// wxCENTER_ON_SCREEN flag is given
|
1999-07-26 05:46:53 -04:00
|
|
|
void Centre( int direction = wxBOTH );
|
|
|
|
void Center( int direction = wxBOTH ) { Centre(direction); }
|
2000-02-02 13:48:41 -05:00
|
|
|
|
|
|
|
// centre on screen (only works for top level windows)
|
|
|
|
void CentreOnScreen(int dir = wxBOTH) { Centre(dir | wxCENTER_ON_SCREEN); }
|
|
|
|
void CenterOnScreen(int dir = wxBOTH) { CentreOnScreen(dir); }
|
|
|
|
|
|
|
|
// centre with respect to the the parent window
|
|
|
|
void CentreOnParent(int dir = wxBOTH) { Centre(dir | wxCENTER_FRAME); }
|
|
|
|
void CenterOnParent(int dir = wxBOTH) { CentreOnParent(dir); }
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// set window size to wrap around its children
|
|
|
|
virtual void Fit();
|
|
|
|
|
|
|
|
// set min/max size of the window
|
|
|
|
virtual void SetSizeHints( int minW, int minH,
|
|
|
|
int maxW = -1, int maxH = -1,
|
|
|
|
int incW = -1, int incH = -1 );
|
|
|
|
|
2002-04-19 18:12:38 -04:00
|
|
|
virtual void SetVirtualSizeHints( int minW, int minH,
|
|
|
|
int maxW = -1, int maxH = -1 );
|
|
|
|
|
2002-02-10 14:08:54 -05:00
|
|
|
virtual int GetMinWidth() const { return m_minWidth; }
|
|
|
|
virtual int GetMinHeight() const { return m_minHeight; }
|
1999-10-11 06:05:36 -04:00
|
|
|
int GetMaxWidth() const { return m_maxWidth; }
|
|
|
|
int GetMaxHeight() const { return m_maxHeight; }
|
1999-11-08 00:18:15 -05:00
|
|
|
|
2002-03-08 21:58:13 -05:00
|
|
|
// Override this method to control the values given to Sizers etc.
|
|
|
|
virtual wxSize GetMaxSize() const { return wxSize( m_maxWidth, m_maxHeight ); }
|
|
|
|
|
2002-04-19 18:12:38 -04:00
|
|
|
// Methods for accessing the virtual size of a window. For most
|
|
|
|
// windows this is just the client area of the window, but for
|
|
|
|
// some like scrolled windows it is more or less independent of
|
|
|
|
// the screen window size. You may override the DoXXXVirtual
|
|
|
|
// methods below for classes where that is is the case.
|
|
|
|
|
|
|
|
void SetVirtualSize( const wxSize &size ) { DoSetVirtualSize( size.x, size.y ); }
|
|
|
|
void SetVirtualSize( int x, int y ) { DoSetVirtualSize( x, y ); }
|
|
|
|
|
|
|
|
wxSize GetVirtualSize() const { return DoGetVirtualSize(); }
|
|
|
|
void GetVirtualSize( int *x, int *y ) const
|
|
|
|
{
|
|
|
|
wxSize s( DoGetVirtualSize() );
|
|
|
|
|
|
|
|
if( x )
|
|
|
|
*x = s.GetWidth();
|
|
|
|
if( y )
|
|
|
|
*y = s.GetHeight();
|
|
|
|
}
|
|
|
|
|
|
|
|
// Override these methods for windows that have a virtual size
|
|
|
|
// independent of their client size. eg. the virtual area of a
|
|
|
|
// wxScrolledWindow. Default is to alias VirtualSize to ClientSize.
|
|
|
|
|
|
|
|
virtual void DoSetVirtualSize( int x, int y );
|
|
|
|
virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// window state
|
|
|
|
// ------------
|
|
|
|
|
|
|
|
// returns TRUE if window was shown/hidden, FALSE if the nothing was
|
|
|
|
// done (window was already shown/hidden)
|
|
|
|
virtual bool Show( bool show = TRUE );
|
|
|
|
bool Hide() { return Show(FALSE); }
|
|
|
|
|
|
|
|
// returns TRUE if window was enabled/disabled, FALSE if nothing done
|
|
|
|
virtual bool Enable( bool enable = TRUE );
|
|
|
|
bool Disable() { return Enable(FALSE); }
|
|
|
|
|
|
|
|
bool IsShown() const { return m_isShown; }
|
|
|
|
bool IsEnabled() const { return m_isEnabled; }
|
|
|
|
|
|
|
|
// get/set window style (setting style won't update the window and so
|
|
|
|
// is only useful for internal usage)
|
|
|
|
virtual void SetWindowStyleFlag( long style ) { m_windowStyle = style; }
|
|
|
|
virtual long GetWindowStyleFlag() const { return m_windowStyle; }
|
|
|
|
|
|
|
|
// just some (somewhat shorter) synonims
|
|
|
|
void SetWindowStyle( long style ) { SetWindowStyleFlag(style); }
|
|
|
|
long GetWindowStyle() const { return GetWindowStyleFlag(); }
|
|
|
|
|
|
|
|
bool HasFlag(int flag) const { return (m_windowStyle & flag) != 0; }
|
2000-01-25 14:59:41 -05:00
|
|
|
virtual bool IsRetained() const { return HasFlag(wxRETAINED); }
|
1999-05-09 18:17:03 -04:00
|
|
|
|
2000-01-25 14:59:41 -05:00
|
|
|
// extra style: the less often used style bits which can't be set with
|
|
|
|
// SetWindowStyleFlag()
|
2002-02-17 17:43:43 -05:00
|
|
|
virtual void SetExtraStyle(long exStyle) { m_exStyle = exStyle; }
|
2000-01-25 14:59:41 -05:00
|
|
|
long GetExtraStyle() const { return m_exStyle; }
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// make the window modal (all other windows unresponsive)
|
|
|
|
virtual void MakeModal(bool modal = TRUE);
|
|
|
|
|
2000-09-15 09:15:37 -04:00
|
|
|
virtual void SetThemeEnabled(bool enableTheme) { m_themeEnabled = enableTheme; }
|
|
|
|
virtual bool GetThemeEnabled() const { return m_themeEnabled; }
|
|
|
|
|
2001-08-05 20:49:59 -04:00
|
|
|
// focus and keyboard handling
|
|
|
|
// ---------------------------
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// set focus to this window
|
|
|
|
virtual void SetFocus() = 0;
|
|
|
|
|
2002-04-20 20:31:35 -04:00
|
|
|
// set focus to this window as the result of a keyboard action
|
|
|
|
virtual void SetFocusFromKbd() { SetFocus(); }
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// return the window which currently has the focus or NULL
|
|
|
|
static wxWindow *FindFocus() /* = 0: implement in derived classes */;
|
|
|
|
|
|
|
|
// can this window have focus?
|
|
|
|
virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); }
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// can this window be given focus by keyboard navigation? if not, the
|
|
|
|
// only way to give it focus (provided it accepts it at all) is to
|
|
|
|
// click it
|
|
|
|
virtual bool AcceptsFocusFromKeyboard() const { return AcceptsFocus(); }
|
|
|
|
|
2001-08-05 20:49:59 -04:00
|
|
|
// NB: these methods really don't belong here but with the current
|
|
|
|
// class hierarchy there is no other place for them :-(
|
|
|
|
|
|
|
|
// get the default child of this parent, i.e. the one which is
|
|
|
|
// activated by pressing <Enter>
|
|
|
|
virtual wxWindow *GetDefaultItem() const { return NULL; }
|
|
|
|
|
|
|
|
// set this child as default, return the old default
|
|
|
|
virtual wxWindow *SetDefaultItem(wxWindow * WXUNUSED(child))
|
|
|
|
{ return NULL; }
|
|
|
|
|
2002-05-11 18:31:05 -04:00
|
|
|
// set this child as temporary default
|
|
|
|
virtual void SetTmpDefaultItem(wxWindow * WXUNUSED(win)) { }
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// parent/children relations
|
|
|
|
// -------------------------
|
|
|
|
|
|
|
|
// get the list of children
|
|
|
|
const wxWindowList& GetChildren() const { return m_children; }
|
|
|
|
wxWindowList& GetChildren() { return m_children; }
|
|
|
|
|
|
|
|
// get the parent or the parent of the parent
|
|
|
|
wxWindow *GetParent() const { return m_parent; }
|
|
|
|
inline wxWindow *GetGrandParent() const;
|
|
|
|
|
|
|
|
// is this window a top level one?
|
1999-11-05 10:54:10 -05:00
|
|
|
virtual bool IsTopLevel() const;
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// it doesn't really change parent, use ReParent() instead
|
|
|
|
void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; }
|
|
|
|
// change the real parent of this window, return TRUE if the parent
|
|
|
|
// was changed, FALSE otherwise (error or newParent == oldParent)
|
|
|
|
virtual bool Reparent( wxWindowBase *newParent );
|
|
|
|
|
2002-05-25 10:24:43 -04:00
|
|
|
// implementation mostly
|
|
|
|
virtual void AddChild( wxWindowBase *child );
|
|
|
|
virtual void RemoveChild( wxWindowBase *child );
|
|
|
|
|
|
|
|
// looking for windows
|
|
|
|
// -------------------
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// find window among the descendants of this one either by id or by
|
|
|
|
// name (return NULL if not found)
|
|
|
|
wxWindow *FindWindow( long id );
|
|
|
|
wxWindow *FindWindow( const wxString& name );
|
|
|
|
|
2002-05-25 10:24:43 -04:00
|
|
|
// Find a window among any window (all return NULL if not found)
|
|
|
|
static wxWindow *FindWindowById( long id, const wxWindow *parent = NULL );
|
|
|
|
static wxWindow *FindWindowByName( const wxString& name,
|
|
|
|
const wxWindow *parent = NULL );
|
|
|
|
static wxWindow *FindWindowByLabel( const wxString& label,
|
|
|
|
const wxWindow *parent = NULL );
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// event handler stuff
|
|
|
|
// -------------------
|
|
|
|
|
|
|
|
// get the current event handler
|
|
|
|
wxEvtHandler *GetEventHandler() const { return m_eventHandler; }
|
|
|
|
|
|
|
|
// replace the event handler (allows to completely subclass the
|
|
|
|
// window)
|
|
|
|
void SetEventHandler( wxEvtHandler *handler ) { m_eventHandler = handler; }
|
|
|
|
|
|
|
|
// push/pop event handler: allows to chain a custom event handler to
|
|
|
|
// alreasy existing ones
|
|
|
|
void PushEventHandler( wxEvtHandler *handler );
|
|
|
|
wxEvtHandler *PopEventHandler( bool deleteHandler = FALSE );
|
|
|
|
|
2002-01-25 11:01:15 -05:00
|
|
|
// find the given handler in the event handler chain and remove (but
|
|
|
|
// not delete) it from the event handler chain, return TRUE if it was
|
|
|
|
// found and FALSE otherwise (this also results in an assert failure so
|
|
|
|
// this function should only be called when the handler is supposed to
|
|
|
|
// be there)
|
|
|
|
bool RemoveEventHandler(wxEvtHandler *handler);
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// validators
|
|
|
|
// ----------
|
1999-05-09 18:17:03 -04:00
|
|
|
|
1999-06-01 11:32:12 -04:00
|
|
|
#if wxUSE_VALIDATORS
|
1999-05-09 18:17:03 -04:00
|
|
|
// a window may have an associated validator which is used to control
|
|
|
|
// user input
|
|
|
|
virtual void SetValidator( const wxValidator &validator );
|
|
|
|
virtual wxValidator *GetValidator() { return m_windowValidator; }
|
1999-06-01 11:32:12 -04:00
|
|
|
#endif // wxUSE_VALIDATORS
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
|
|
|
|
// dialog oriented functions
|
|
|
|
// -------------------------
|
|
|
|
|
|
|
|
// validate the correctness of input, return TRUE if ok
|
|
|
|
virtual bool Validate();
|
|
|
|
|
|
|
|
// transfer data between internal and GUI representations
|
|
|
|
virtual bool TransferDataToWindow();
|
|
|
|
virtual bool TransferDataFromWindow();
|
|
|
|
|
|
|
|
virtual void InitDialog();
|
|
|
|
|
1999-06-01 11:32:12 -04:00
|
|
|
#if wxUSE_ACCEL
|
1999-05-09 18:17:03 -04:00
|
|
|
// accelerators
|
|
|
|
// ------------
|
|
|
|
virtual void SetAcceleratorTable( const wxAcceleratorTable& accel )
|
|
|
|
{ m_acceleratorTable = accel; }
|
|
|
|
wxAcceleratorTable *GetAcceleratorTable()
|
|
|
|
{ return &m_acceleratorTable; }
|
1999-06-01 11:32:12 -04:00
|
|
|
#endif // wxUSE_ACCEL
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// dialog units translations
|
|
|
|
// -------------------------
|
|
|
|
|
|
|
|
wxPoint ConvertPixelsToDialog( const wxPoint& pt );
|
|
|
|
wxPoint ConvertDialogToPixels( const wxPoint& pt );
|
|
|
|
wxSize ConvertPixelsToDialog( const wxSize& sz )
|
|
|
|
{
|
|
|
|
wxPoint pt(ConvertPixelsToDialog(wxPoint(sz.x, sz.y)));
|
|
|
|
|
|
|
|
return wxSize(pt.x, pt.y);
|
|
|
|
}
|
|
|
|
|
|
|
|
wxSize ConvertDialogToPixels( const wxSize& sz )
|
|
|
|
{
|
|
|
|
wxPoint pt(ConvertDialogToPixels(wxPoint(sz.x, sz.y)));
|
|
|
|
|
|
|
|
return wxSize(pt.x, pt.y);
|
|
|
|
}
|
|
|
|
|
|
|
|
// mouse functions
|
|
|
|
// ---------------
|
|
|
|
|
|
|
|
// move the mouse to the specified position
|
|
|
|
virtual void WarpPointer(int x, int y) = 0;
|
|
|
|
|
2002-01-19 14:31:19 -05:00
|
|
|
// start or end mouse capture, these functions maintain the stack of
|
|
|
|
// windows having captured the mouse and after calling ReleaseMouse()
|
|
|
|
// the mouse is not released but returns to the window which had had
|
|
|
|
// captured it previously (if any)
|
|
|
|
void CaptureMouse();
|
|
|
|
void ReleaseMouse();
|
1999-05-09 18:17:03 -04:00
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// get the window which currently captures the mouse or NULL
|
|
|
|
static wxWindow *GetCapture();
|
|
|
|
|
|
|
|
// does this window have the capture?
|
|
|
|
virtual bool HasCapture() const
|
|
|
|
{ return (wxWindow *)this == GetCapture(); }
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// painting the window
|
|
|
|
// -------------------
|
|
|
|
|
|
|
|
// mark the specified rectangle (or the whole window) as "dirty" so it
|
|
|
|
// will be repainted
|
|
|
|
virtual void Refresh( bool eraseBackground = TRUE,
|
|
|
|
const wxRect *rect = (const wxRect *) NULL ) = 0;
|
2001-06-26 16:59:19 -04:00
|
|
|
|
|
|
|
// a less awkward wrapper for Refresh
|
|
|
|
void RefreshRect(const wxRect& rect) { Refresh(TRUE, &rect); }
|
|
|
|
|
|
|
|
// repaint all invalid areas of the window immediately
|
|
|
|
virtual void Update() { }
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// clear the window entirely
|
|
|
|
virtual void Clear() = 0;
|
|
|
|
|
2001-07-26 04:33:53 -04:00
|
|
|
// freeze the window: don't redraw it until it is thawed
|
|
|
|
virtual void Freeze() { }
|
|
|
|
|
|
|
|
// thaw the window: redraw it after it had been frozen
|
|
|
|
virtual void Thaw() { }
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// adjust DC for drawing on this window
|
1999-05-11 08:11:21 -04:00
|
|
|
virtual void PrepareDC( wxDC & WXUNUSED(dc) ) { }
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// the update region of the window contains the areas which must be
|
|
|
|
// repainted by the program
|
|
|
|
const wxRegion& GetUpdateRegion() const { return m_updateRegion; }
|
|
|
|
wxRegion& GetUpdateRegion() { return m_updateRegion; }
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// get the update rectangleregion bounding box in client coords
|
|
|
|
wxRect GetUpdateClientRect() const;
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// these functions verify whether the given point/rectangle belongs to
|
|
|
|
// (or at least intersects with) the update region
|
|
|
|
bool IsExposed( int x, int y ) const;
|
|
|
|
bool IsExposed( int x, int y, int w, int h ) const;
|
|
|
|
|
|
|
|
bool IsExposed( const wxPoint& pt ) const
|
|
|
|
{ return IsExposed(pt.x, pt.y); }
|
|
|
|
bool IsExposed( const wxRect& rect ) const
|
|
|
|
{ return IsExposed(rect.x, rect.y, rect.width, rect.height); }
|
|
|
|
|
|
|
|
// colours, fonts and cursors
|
|
|
|
// --------------------------
|
|
|
|
|
|
|
|
// set/retrieve the window colours (system defaults are used by
|
|
|
|
// default): Set functions return TRUE if colour was changed
|
|
|
|
virtual bool SetBackgroundColour( const wxColour &colour );
|
|
|
|
virtual bool SetForegroundColour( const wxColour &colour );
|
|
|
|
|
|
|
|
wxColour GetBackgroundColour() const { return m_backgroundColour; }
|
|
|
|
wxColour GetForegroundColour() const { return m_foregroundColour; }
|
|
|
|
|
|
|
|
// set/retrieve the cursor for this window (SetCursor() returns TRUE
|
|
|
|
// if the cursor was really changed)
|
|
|
|
virtual bool SetCursor( const wxCursor &cursor );
|
|
|
|
const wxCursor& GetCursor() const { return m_cursor; }
|
|
|
|
wxCursor& GetCursor() { return m_cursor; }
|
|
|
|
|
|
|
|
// set/retrieve the font for the window (SetFont() returns TRUE if the
|
|
|
|
// font really changed)
|
|
|
|
virtual bool SetFont( const wxFont &font ) = 0;
|
|
|
|
const wxFont& GetFont() const { return m_font; }
|
|
|
|
wxFont& GetFont() { return m_font; }
|
|
|
|
|
1999-05-23 19:48:12 -04:00
|
|
|
#if wxUSE_CARET
|
|
|
|
// associate a caret with the window
|
|
|
|
void SetCaret(wxCaret *caret);
|
|
|
|
// get the current caret (may be NULL)
|
|
|
|
wxCaret *GetCaret() const { return m_caret; }
|
|
|
|
#endif // wxUSE_CARET
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// get the (average) character size for the current font
|
|
|
|
virtual int GetCharHeight() const = 0;
|
|
|
|
virtual int GetCharWidth() const = 0;
|
|
|
|
|
|
|
|
// get the width/height/... of the text using current or specified
|
|
|
|
// font
|
|
|
|
virtual void GetTextExtent(const wxString& string,
|
|
|
|
int *x, int *y,
|
|
|
|
int *descent = (int *) NULL,
|
|
|
|
int *externalLeading = (int *) NULL,
|
|
|
|
const wxFont *theFont = (const wxFont *) NULL)
|
|
|
|
const = 0;
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// client <-> screen coords
|
|
|
|
// ------------------------
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// translate to/from screen/client coordinates (pointers may be NULL)
|
1999-05-18 21:00:57 -04:00
|
|
|
void ClientToScreen( int *x, int *y ) const
|
|
|
|
{ DoClientToScreen(x, y); }
|
|
|
|
void ScreenToClient( int *x, int *y ) const
|
|
|
|
{ DoScreenToClient(x, y); }
|
2001-06-26 16:59:19 -04:00
|
|
|
|
|
|
|
// wxPoint interface to do the same thing
|
1999-05-18 21:00:57 -04:00
|
|
|
wxPoint ClientToScreen(const wxPoint& pt) const
|
|
|
|
{
|
|
|
|
int x = pt.x, y = pt.y;
|
|
|
|
DoClientToScreen(&x, &y);
|
|
|
|
|
|
|
|
return wxPoint(x, y);
|
|
|
|
}
|
|
|
|
|
|
|
|
wxPoint ScreenToClient(const wxPoint& pt) const
|
|
|
|
{
|
|
|
|
int x = pt.x, y = pt.y;
|
|
|
|
DoScreenToClient(&x, &y);
|
|
|
|
|
|
|
|
return wxPoint(x, y);
|
|
|
|
}
|
1999-05-09 18:17:03 -04:00
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// test where the given (in client coords) point lies
|
|
|
|
wxHitTest HitTest(wxCoord x, wxCoord y) const
|
|
|
|
{ return DoHitTest(x, y); }
|
|
|
|
|
|
|
|
wxHitTest HitTest(const wxPoint& pt) const
|
|
|
|
{ return DoHitTest(pt.x, pt.y); }
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// misc
|
|
|
|
// ----
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// get the window border style: uses the current style and falls back to
|
|
|
|
// the default style for this class otherwise (see GetDefaultBorder())
|
|
|
|
wxBorder GetBorder() const;
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
void UpdateWindowUI();
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
#if wxUSE_MENUS
|
1999-07-20 19:22:30 -04:00
|
|
|
bool PopupMenu( wxMenu *menu, const wxPoint& pos )
|
|
|
|
{ return DoPopupMenu(menu, pos.x, pos.y); }
|
|
|
|
bool PopupMenu( wxMenu *menu, int x, int y )
|
|
|
|
{ return DoPopupMenu(menu, x, y); }
|
2001-06-26 16:59:19 -04:00
|
|
|
#endif // wxUSE_MENUS
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// scrollbars
|
|
|
|
// ----------
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// does the window have the scrollbar for this orientation?
|
|
|
|
bool HasScrollbar(int orient) const
|
|
|
|
{
|
|
|
|
return (m_windowStyle &
|
|
|
|
(orient == wxHORIZONTAL ? wxHSCROLL : wxVSCROLL)) != 0;
|
|
|
|
}
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// configure the window scrollbars
|
|
|
|
virtual void SetScrollbar( int orient,
|
|
|
|
int pos,
|
2001-06-26 16:59:19 -04:00
|
|
|
int thumbvisible,
|
1999-05-09 18:17:03 -04:00
|
|
|
int range,
|
|
|
|
bool refresh = TRUE ) = 0;
|
|
|
|
virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE ) = 0;
|
|
|
|
virtual int GetScrollPos( int orient ) const = 0;
|
|
|
|
virtual int GetScrollThumb( int orient ) const = 0;
|
|
|
|
virtual int GetScrollRange( int orient ) const = 0;
|
|
|
|
|
|
|
|
// scroll window to the specified position
|
|
|
|
virtual void ScrollWindow( int dx, int dy,
|
|
|
|
const wxRect* rect = (wxRect *) NULL ) = 0;
|
|
|
|
|
2001-07-29 18:47:40 -04:00
|
|
|
// scrolls window by line/page: note that not all controls support this
|
2001-07-30 11:22:38 -04:00
|
|
|
//
|
|
|
|
// return TRUE if the position changed, FALSE otherwise
|
|
|
|
virtual bool ScrollLines(int WXUNUSED(lines)) { return FALSE; }
|
|
|
|
virtual bool ScrollPages(int WXUNUSED(pages)) { return FALSE; }
|
|
|
|
|
|
|
|
// convenient wrappers for ScrollLines/Pages
|
|
|
|
bool LineUp() { return ScrollLines(-1); }
|
|
|
|
bool LineDown() { return ScrollLines(1); }
|
|
|
|
bool PageUp() { return ScrollPages(-1); }
|
|
|
|
bool PageDown() { return ScrollPages(1); }
|
2001-07-29 18:47:40 -04:00
|
|
|
|
2000-09-10 08:43:37 -04:00
|
|
|
// context-sensitive help
|
|
|
|
// ----------------------
|
|
|
|
|
|
|
|
// these are the convenience functions wrapping wxHelpProvider methods
|
|
|
|
|
|
|
|
#if wxUSE_HELP
|
|
|
|
// associate this help text with this window
|
|
|
|
void SetHelpText(const wxString& text);
|
|
|
|
// associate this help text with all windows with the same id as this
|
|
|
|
// one
|
|
|
|
void SetHelpTextForId(const wxString& text);
|
|
|
|
// get the help string associated with this window (may be empty)
|
|
|
|
wxString GetHelpText() const;
|
|
|
|
#endif // wxUSE_HELP
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// tooltips
|
|
|
|
// --------
|
2000-09-10 08:43:37 -04:00
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
#if wxUSE_TOOLTIPS
|
|
|
|
// the easiest way to set a tooltip for a window is to use this method
|
|
|
|
void SetToolTip( const wxString &tip );
|
|
|
|
// attach a tooltip to the window
|
|
|
|
void SetToolTip( wxToolTip *tip ) { DoSetToolTip(tip); }
|
|
|
|
// get the associated tooltip or NULL if none
|
|
|
|
wxToolTip* GetToolTip() const { return m_tooltip; }
|
|
|
|
#endif // wxUSE_TOOLTIPS
|
|
|
|
|
|
|
|
// drag and drop
|
|
|
|
// -------------
|
|
|
|
#if wxUSE_DRAG_AND_DROP
|
|
|
|
// set/retrieve the drop target associated with this window (may be
|
|
|
|
// NULL; it's owned by the window and will be deleted by it)
|
|
|
|
virtual void SetDropTarget( wxDropTarget *dropTarget ) = 0;
|
|
|
|
virtual wxDropTarget *GetDropTarget() const { return m_dropTarget; }
|
|
|
|
#endif // wxUSE_DRAG_AND_DROP
|
|
|
|
|
|
|
|
// constraints and sizers
|
|
|
|
// ----------------------
|
|
|
|
#if wxUSE_CONSTRAINTS
|
|
|
|
// set the constraints for this window or retrieve them (may be NULL)
|
|
|
|
void SetConstraints( wxLayoutConstraints *constraints );
|
|
|
|
wxLayoutConstraints *GetConstraints() const { return m_constraints; }
|
|
|
|
|
|
|
|
// implementation only
|
|
|
|
void UnsetConstraints(wxLayoutConstraints *c);
|
|
|
|
wxWindowList *GetConstraintsInvolvedIn() const
|
|
|
|
{ return m_constraintsInvolvedIn; }
|
|
|
|
void AddConstraintReference(wxWindowBase *otherWin);
|
|
|
|
void RemoveConstraintReference(wxWindowBase *otherWin);
|
|
|
|
void DeleteRelatedConstraints();
|
|
|
|
void ResetConstraints();
|
|
|
|
|
|
|
|
// these methods may be overriden for special layout algorithms
|
|
|
|
virtual void SetConstraintSizes(bool recurse = TRUE);
|
|
|
|
virtual bool LayoutPhase1(int *noChanges);
|
|
|
|
virtual bool LayoutPhase2(int *noChanges);
|
2000-01-21 16:38:51 -05:00
|
|
|
virtual bool DoPhase(int phase);
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// these methods are virtual but normally won't be overridden
|
|
|
|
virtual void SetSizeConstraint(int x, int y, int w, int h);
|
|
|
|
virtual void MoveConstraint(int x, int y);
|
|
|
|
virtual void GetSizeConstraint(int *w, int *h) const ;
|
|
|
|
virtual void GetClientSizeConstraint(int *w, int *h) const ;
|
|
|
|
virtual void GetPositionConstraint(int *x, int *y) const ;
|
|
|
|
|
2002-02-23 12:36:48 -05:00
|
|
|
#endif // wxUSE_CONSTRAINTS
|
|
|
|
|
|
|
|
// when using constraints or sizers, it makes sense to update
|
|
|
|
// children positions automatically whenever the window is resized
|
|
|
|
// - this is done if autoLayout is on
|
|
|
|
void SetAutoLayout( bool autoLayout ) { m_autoLayout = autoLayout; }
|
|
|
|
bool GetAutoLayout() const { return m_autoLayout; }
|
|
|
|
|
|
|
|
// lay out the window and its children
|
|
|
|
virtual bool Layout();
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// sizers
|
2002-03-10 06:19:16 -05:00
|
|
|
void SetSizer(wxSizer *sizer, bool deleteOld = TRUE );
|
2002-04-19 18:12:38 -04:00
|
|
|
void SetSizerAndFit( wxSizer *sizer, bool deleteOld = TRUE );
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
wxSizer *GetSizer() const { return m_windowSizer; }
|
2002-02-14 18:34:46 -05:00
|
|
|
|
|
|
|
// Track if this window is a member of a sizer
|
|
|
|
void SetContainingSizer(wxSizer* sizer) { m_containingSizer = sizer; }
|
|
|
|
wxSizer *GetContainingSizer() const { return m_containingSizer; }
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// backward compatibility
|
|
|
|
// ----------------------
|
|
|
|
#if WXWIN_COMPATIBILITY
|
|
|
|
bool Enabled() const { return IsEnabled(); }
|
|
|
|
|
|
|
|
void SetButtonFont(const wxFont& font) { SetFont(font); }
|
|
|
|
void SetLabelFont(const wxFont& font) { SetFont(font); }
|
|
|
|
wxFont& GetLabelFont() { return GetFont(); };
|
|
|
|
wxFont& GetButtonFont() { return GetFont(); };
|
|
|
|
#endif // WXWIN_COMPATIBILITY
|
|
|
|
|
|
|
|
// implementation
|
|
|
|
// --------------
|
|
|
|
|
|
|
|
// event handlers
|
|
|
|
void OnSysColourChanged( wxSysColourChangedEvent& event );
|
|
|
|
void OnInitDialog( wxInitDialogEvent &event );
|
2000-01-28 20:12:55 -05:00
|
|
|
void OnMiddleClick( wxMouseEvent& event );
|
2000-09-10 08:43:37 -04:00
|
|
|
#if wxUSE_HELP
|
|
|
|
void OnHelp(wxHelpEvent& event);
|
|
|
|
#endif // wxUSE_HELP
|
1999-05-09 18:17:03 -04:00
|
|
|
|
1999-05-10 18:29:23 -04:00
|
|
|
// get the haqndle of the window for the underlying window system: this
|
|
|
|
// is only used for wxWin itself or for user code which wants to call
|
|
|
|
// platform-specific APIs
|
1999-08-02 17:31:09 -04:00
|
|
|
virtual WXWidget GetHandle() const = 0;
|
1999-05-09 20:42:57 -04:00
|
|
|
|
2002-02-07 13:46:31 -05:00
|
|
|
#if wxUSE_PALETTE
|
|
|
|
// Store the palette used by DCs in wxWindow so that the dcs can share
|
|
|
|
// a palette. And we can respond to palette messages.
|
|
|
|
wxPalette GetPalette() const { return m_palette; }
|
2002-02-07 19:18:10 -05:00
|
|
|
|
2002-02-07 13:46:31 -05:00
|
|
|
// When palette is changed tell the DC to set the system palette to the
|
|
|
|
// new one.
|
2002-02-07 19:18:10 -05:00
|
|
|
void SetPalette(const wxPalette& pal);
|
|
|
|
|
|
|
|
// return true if we have a specific palette
|
|
|
|
bool HasCustomPalette() const { return m_hasCustomPalette; }
|
|
|
|
|
|
|
|
// return the first parent window with a custom palette or NULL
|
|
|
|
wxWindow *GetAncestorWithCustomPalette() const;
|
2002-02-07 13:46:31 -05:00
|
|
|
#endif // wxUSE_PALETTE
|
|
|
|
|
1999-05-10 17:04:17 -04:00
|
|
|
protected:
|
2002-05-26 18:37:42 -04:00
|
|
|
#if wxUSE_CONSTRAINTS
|
|
|
|
// satisfy the constraints for the windows but don't set the window sizes
|
|
|
|
void SatisfyConstraints();
|
|
|
|
#endif // wxUSE_CONSTRAINTS
|
2002-04-19 18:12:38 -04:00
|
|
|
|
1999-05-17 13:07:46 -04:00
|
|
|
// the window id - a number which uniquely identifies a window among
|
1999-05-10 18:29:23 -04:00
|
|
|
// its siblings unless it is -1
|
1999-05-09 18:17:03 -04:00
|
|
|
wxWindowID m_windowId;
|
2001-08-05 20:49:59 -04:00
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// the parent window of this window (or NULL) and the list of the children
|
|
|
|
// of this window
|
|
|
|
wxWindow *m_parent;
|
|
|
|
wxWindowList m_children;
|
|
|
|
|
|
|
|
// the minimal allowed size for the window (no minimal size if variable(s)
|
|
|
|
// contain(s) -1)
|
2002-05-26 18:37:42 -04:00
|
|
|
int m_minWidth,
|
|
|
|
m_minHeight,
|
|
|
|
m_maxWidth,
|
|
|
|
m_maxHeight;
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// event handler for this window: usually is just 'this' but may be
|
|
|
|
// changed with SetEventHandler()
|
|
|
|
wxEvtHandler *m_eventHandler;
|
|
|
|
|
1999-06-01 11:32:12 -04:00
|
|
|
#if wxUSE_VALIDATORS
|
1999-05-09 18:17:03 -04:00
|
|
|
// associated validator or NULL if none
|
|
|
|
wxValidator *m_windowValidator;
|
1999-06-01 11:32:12 -04:00
|
|
|
#endif // wxUSE_VALIDATORS
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
#if wxUSE_DRAG_AND_DROP
|
|
|
|
wxDropTarget *m_dropTarget;
|
|
|
|
#endif // wxUSE_DRAG_AND_DROP
|
|
|
|
|
|
|
|
// visual window attributes
|
|
|
|
wxCursor m_cursor;
|
|
|
|
wxFont m_font;
|
|
|
|
wxColour m_backgroundColour, m_foregroundColour;
|
|
|
|
|
1999-05-23 19:48:12 -04:00
|
|
|
#if wxUSE_CARET
|
|
|
|
wxCaret *m_caret;
|
|
|
|
#endif // wxUSE_CARET
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// the region which should be repainted in response to paint event
|
|
|
|
wxRegion m_updateRegion;
|
|
|
|
|
1999-06-01 11:32:12 -04:00
|
|
|
#if wxUSE_ACCEL
|
1999-05-09 18:17:03 -04:00
|
|
|
// the accelerator table for the window which translates key strokes into
|
|
|
|
// command events
|
|
|
|
wxAcceleratorTable m_acceleratorTable;
|
1999-06-01 11:32:12 -04:00
|
|
|
#endif // wxUSE_ACCEL
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// the tooltip for this window (may be NULL)
|
|
|
|
#if wxUSE_TOOLTIPS
|
|
|
|
wxToolTip *m_tooltip;
|
|
|
|
#endif // wxUSE_TOOLTIPS
|
|
|
|
|
|
|
|
// constraints and sizers
|
|
|
|
#if wxUSE_CONSTRAINTS
|
|
|
|
// the constraints for this window or NULL
|
|
|
|
wxLayoutConstraints *m_constraints;
|
|
|
|
|
|
|
|
// constraints this window is involved in
|
|
|
|
wxWindowList *m_constraintsInvolvedIn;
|
2002-02-23 12:36:48 -05:00
|
|
|
#endif // wxUSE_CONSTRAINTS
|
1999-05-09 18:17:03 -04:00
|
|
|
|
2002-02-14 18:34:46 -05:00
|
|
|
// this window's sizer
|
1999-05-09 18:17:03 -04:00
|
|
|
wxSizer *m_windowSizer;
|
2002-02-14 18:34:46 -05:00
|
|
|
|
|
|
|
// The sizer this window is a member of, if any
|
|
|
|
wxSizer *m_containingSizer;
|
1999-05-09 18:17:03 -04:00
|
|
|
|
|
|
|
// Layout() window automatically when its size changes?
|
|
|
|
bool m_autoLayout:1;
|
|
|
|
|
|
|
|
// window state
|
|
|
|
bool m_isShown:1;
|
|
|
|
bool m_isEnabled:1;
|
|
|
|
bool m_isBeingDeleted:1;
|
|
|
|
|
2001-12-07 19:26:30 -05:00
|
|
|
// was the window colours/font explicitly changed by user?
|
|
|
|
bool m_hasBgCol:1;
|
|
|
|
bool m_hasFgCol:1;
|
|
|
|
bool m_hasFont:1;
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// window attributes
|
2000-01-25 14:59:41 -05:00
|
|
|
long m_windowStyle,
|
|
|
|
m_exStyle;
|
1999-05-09 18:17:03 -04:00
|
|
|
wxString m_windowName;
|
2000-09-15 09:15:37 -04:00
|
|
|
bool m_themeEnabled;
|
1999-05-09 18:17:03 -04:00
|
|
|
|
2002-02-14 08:47:33 -05:00
|
|
|
#if wxUSE_PALETTE
|
2002-02-07 13:46:31 -05:00
|
|
|
wxPalette m_palette;
|
2002-02-07 19:18:10 -05:00
|
|
|
bool m_hasCustomPalette;
|
|
|
|
#endif // wxUSE_PALETTE
|
2002-02-07 13:46:31 -05:00
|
|
|
|
2002-04-19 18:12:38 -04:00
|
|
|
// Virtual size (scrolling)
|
|
|
|
wxSize m_virtualSize;
|
|
|
|
|
|
|
|
int m_minVirtualWidth; // VirtualSizeHints
|
|
|
|
int m_minVirtualHeight;
|
|
|
|
int m_maxVirtualWidth;
|
|
|
|
int m_maxVirtualHeight;
|
2002-02-03 23:19:14 -05:00
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// common part of all ctors: it is not virtual because it is called from
|
|
|
|
// ctor
|
|
|
|
void InitBase();
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// override this to change the default (i.e. used when no style is
|
|
|
|
// specified) border for the window class
|
|
|
|
virtual wxBorder GetDefaultBorder() const;
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// get the default size for the new window if no explicit size given
|
2002-07-08 10:01:04 -04:00
|
|
|
// FIXME why 20 and not 30, 10 or ...?
|
|
|
|
static int WidthDefault(int w) { return w == -1 ? 20 : w; }
|
|
|
|
static int HeightDefault(int h) { return h == -1 ? 20 : h; }
|
1999-05-09 18:17:03 -04:00
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// set the best size for the control if the default size was given:
|
|
|
|
// replaces the fields of size == -1 with the best values for them and
|
|
|
|
// calls SetSize() if needed
|
|
|
|
void SetBestSize(const wxSize& size)
|
1999-11-19 16:01:20 -05:00
|
|
|
{
|
|
|
|
if ( size.x == -1 || size.y == -1 )
|
|
|
|
{
|
2001-06-26 16:59:19 -04:00
|
|
|
wxSize sizeBest = DoGetBestSize();
|
|
|
|
if ( size.x != -1 )
|
|
|
|
sizeBest.x = size.x;
|
|
|
|
if ( size.y != -1 )
|
|
|
|
sizeBest.y = size.y;
|
|
|
|
|
|
|
|
SetSize(sizeBest);
|
1999-11-19 16:01:20 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// more pure virtual functions
|
|
|
|
// ---------------------------
|
|
|
|
|
|
|
|
// NB: we must have DoSomething() function when Something() is an overloaded
|
|
|
|
// method: indeed, we can't just have "virtual Something()" in case when
|
|
|
|
// the function is overloaded because then we'd have to make virtual all
|
|
|
|
// the variants (otherwise only the virtual function may be called on a
|
|
|
|
// pointer to derived class according to C++ rules) which is, in
|
|
|
|
// general, absolutely not needed. So instead we implement all
|
|
|
|
// overloaded Something()s in terms of DoSomething() which will be the
|
|
|
|
// only one to be virtual.
|
|
|
|
|
1999-05-18 21:00:57 -04:00
|
|
|
// coordinates translation
|
|
|
|
virtual void DoClientToScreen( int *x, int *y ) const = 0;
|
|
|
|
virtual void DoScreenToClient( int *x, int *y ) const = 0;
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
virtual wxHitTest DoHitTest(wxCoord x, wxCoord y) const;
|
|
|
|
|
2002-01-19 14:31:19 -05:00
|
|
|
// capture/release the mouse, used by Capture/ReleaseMouse()
|
2002-01-19 14:39:53 -05:00
|
|
|
virtual void DoCaptureMouse() = 0;
|
|
|
|
virtual void DoReleaseMouse() = 0;
|
2002-02-14 18:34:46 -05:00
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// retrieve the position/size of the window
|
|
|
|
virtual void DoGetPosition( int *x, int *y ) const = 0;
|
|
|
|
virtual void DoGetSize( int *width, int *height ) const = 0;
|
|
|
|
virtual void DoGetClientSize( int *width, int *height ) const = 0;
|
|
|
|
|
1999-11-19 16:01:20 -05:00
|
|
|
// get the size which best suits the window: for a control, it would be
|
|
|
|
// the minimal size which doesn't truncate the control, for a panel - the
|
|
|
|
// same size as it would have after a call to Fit()
|
|
|
|
virtual wxSize DoGetBestSize() const;
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// this is the virtual function to be overriden in any derived class which
|
|
|
|
// wants to change how SetSize() or Move() works - it is called by all
|
|
|
|
// versions of these functions in the base class
|
|
|
|
virtual void DoSetSize(int x, int y,
|
|
|
|
int width, int height,
|
|
|
|
int sizeFlags = wxSIZE_AUTO) = 0;
|
|
|
|
|
|
|
|
// same as DoSetSize() for the client size
|
|
|
|
virtual void DoSetClientSize(int width, int height) = 0;
|
|
|
|
|
1999-12-29 14:18:01 -05:00
|
|
|
// move the window to the specified location and resize it: this is called
|
|
|
|
// from both DoSetSize() and DoSetClientSize() and would usually just
|
|
|
|
// reposition this window except for composite controls which will want to
|
|
|
|
// arrange themselves inside the given rectangle
|
|
|
|
virtual void DoMoveWindow(int x, int y, int width, int height) = 0;
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
#if wxUSE_TOOLTIPS
|
|
|
|
virtual void DoSetToolTip( wxToolTip *tip );
|
|
|
|
#endif // wxUSE_TOOLTIPS
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
#if wxUSE_MENUS
|
1999-07-20 19:22:30 -04:00
|
|
|
virtual bool DoPopupMenu( wxMenu *menu, int x, int y ) = 0;
|
2001-06-26 16:59:19 -04:00
|
|
|
#endif // wxUSE_MENUS
|
1999-07-20 19:22:30 -04:00
|
|
|
|
2001-09-18 18:36:18 -04:00
|
|
|
// Makes an adjustment to the window position (for example, a frame that has
|
|
|
|
// a toolbar that it manages itself).
|
2002-02-23 19:17:23 -05:00
|
|
|
virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags) const;
|
1999-07-26 19:02:32 -04:00
|
|
|
|
2002-02-03 23:19:14 -05:00
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
private:
|
2002-02-03 23:19:14 -05:00
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// contains the last id generated by NewControlId
|
|
|
|
static int ms_lastControlId;
|
|
|
|
|
2002-01-19 14:39:53 -05:00
|
|
|
// the stack of windows which have captured the mouse
|
|
|
|
static struct WXDLLEXPORT wxWindowNext *ms_winCaptureNext;
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
DECLARE_ABSTRACT_CLASS(wxWindowBase)
|
|
|
|
DECLARE_NO_COPY_CLASS(wxWindowBase)
|
1999-05-09 18:17:03 -04:00
|
|
|
DECLARE_EVENT_TABLE()
|
|
|
|
};
|
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// now include the declaration of wxWindow class
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// include the declaration of the platform-specific class
|
1998-07-10 10:15:17 -04:00
|
|
|
#if defined(__WXMSW__)
|
2001-06-29 12:51:05 -04:00
|
|
|
#ifdef __WXUNIVERSAL__
|
|
|
|
#define wxWindowNative wxWindowMSW
|
|
|
|
#else // !wxUniv
|
2001-06-26 16:59:19 -04:00
|
|
|
#define wxWindowMSW wxWindow
|
|
|
|
#define sm_classwxWindowMSW sm_classwxWindow
|
2001-06-29 12:51:05 -04:00
|
|
|
#endif // wxUniv/!wxUniv
|
1999-05-09 18:17:03 -04:00
|
|
|
#include "wx/msw/window.h"
|
1998-07-10 10:15:17 -04:00
|
|
|
#elif defined(__WXMOTIF__)
|
1999-05-09 18:17:03 -04:00
|
|
|
#include "wx/motif/window.h"
|
1998-07-10 10:15:17 -04:00
|
|
|
#elif defined(__WXGTK__)
|
2001-06-29 12:51:05 -04:00
|
|
|
#ifdef __WXUNIVERSAL__
|
|
|
|
#define wxWindowNative wxWindowGTK
|
|
|
|
#else // !wxUniv
|
2001-06-26 16:59:19 -04:00
|
|
|
#define wxWindowGTK wxWindow
|
|
|
|
#define sm_classwxWindowGTK sm_classwxWindow
|
|
|
|
#endif // wxUniv
|
1999-05-09 18:17:03 -04:00
|
|
|
#include "wx/gtk/window.h"
|
2002-02-05 11:34:33 -05:00
|
|
|
#elif defined(__WXX11__)
|
|
|
|
#ifdef __WXUNIVERSAL__
|
|
|
|
#define wxWindowNative wxWindowX11
|
|
|
|
#else // !wxUniv
|
|
|
|
#define wxWindowX11 wxWindow
|
|
|
|
#define sm_classwxWindowX11 sm_classwxWindow
|
|
|
|
#endif // wxUniv
|
|
|
|
#include "wx/x11/window.h"
|
2001-07-31 18:44:30 -04:00
|
|
|
#elif defined(__WXMGL__)
|
2001-07-28 18:39:51 -04:00
|
|
|
#ifdef __WXUNIVERSAL__
|
|
|
|
#define wxWindowNative wxWindowMGL
|
|
|
|
#else // !wxUniv
|
|
|
|
#define wxWindowMGL wxWindow
|
|
|
|
#define sm_classwxWindowMGL sm_classwxWindow
|
|
|
|
#endif // wxUniv
|
|
|
|
#include "wx/mgl/window.h"
|
1998-08-14 20:23:28 -04:00
|
|
|
#elif defined(__WXMAC__)
|
2001-07-04 16:11:26 -04:00
|
|
|
#ifdef __WXUNIVERSAL__
|
|
|
|
#define wxWindowNative wxWindowMac
|
|
|
|
#else // !wxUniv
|
|
|
|
#define wxWindowMac wxWindow
|
|
|
|
#define sm_classwxWindowMac sm_classwxWindow
|
|
|
|
#endif // wxUniv
|
1999-05-09 18:17:03 -04:00
|
|
|
#include "wx/mac/window.h"
|
1999-07-27 23:38:12 -04:00
|
|
|
#elif defined(__WXPM__)
|
2001-07-06 17:45:11 -04:00
|
|
|
#ifdef __WXUNIVERSAL__
|
|
|
|
#define wxWindowNative wxWindowOS2
|
|
|
|
#else // !wxUniv
|
|
|
|
#define wxWindowOS2 wxWindow
|
|
|
|
#define sm_classwxWindowOS2 sm_classwxWindow
|
|
|
|
#endif // wxUniv/!wxUniv
|
1999-07-27 23:38:12 -04:00
|
|
|
#include "wx/os2/window.h"
|
1998-05-20 10:01:55 -04:00
|
|
|
#endif
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// for wxUniversal, we now derive the real wxWindow from wxWindow<platform>,
|
|
|
|
// for the native ports we already have defined it above
|
|
|
|
#if defined(__WXUNIVERSAL__)
|
2001-06-29 12:51:05 -04:00
|
|
|
#ifndef wxWindowNative
|
|
|
|
#error "wxWindowNative must be defined above!"
|
|
|
|
#endif
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
#include "wx/univ/window.h"
|
|
|
|
#endif // wxUniv
|
|
|
|
|
1999-05-09 18:17:03 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// inline functions which couldn't be declared in the class body because of
|
|
|
|
// forward dependencies
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
1999-05-10 12:59:16 -04:00
|
|
|
inline wxWindow *wxWindowBase::GetGrandParent() const
|
1999-05-09 18:17:03 -04:00
|
|
|
{
|
|
|
|
return m_parent ? m_parent->GetParent() : (wxWindow *)NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
2000-09-07 05:43:05 -04:00
|
|
|
// global functions
|
1999-05-09 18:17:03 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
2000-09-07 05:43:05 -04:00
|
|
|
// Find the wxWindow at the current mouse position, also returning the mouse
|
|
|
|
// position.
|
|
|
|
WXDLLEXPORT extern wxWindow* wxFindWindowAtPointer(wxPoint& pt);
|
|
|
|
|
|
|
|
// Get the current mouse position.
|
|
|
|
WXDLLEXPORT extern wxPoint wxGetMousePosition();
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// get the currently active window of this application or NULL
|
|
|
|
WXDLLEXPORT extern wxWindow *wxGetActiveWindow();
|
|
|
|
|
2002-04-20 09:51:28 -04:00
|
|
|
// get the (first) top level parent window
|
|
|
|
WXDLLEXPORT wxWindow* wxGetTopLevelParent(wxWindow *win);
|
|
|
|
|
1999-11-19 16:01:20 -05:00
|
|
|
// deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
|
2001-04-26 12:38:11 -04:00
|
|
|
inline int NewControlId() { return wxWindowBase::NewControlId(); }
|
1999-05-09 18:17:03 -04:00
|
|
|
|
1998-05-20 10:01:55 -04:00
|
|
|
#endif
|
1998-08-14 20:23:28 -04:00
|
|
|
// _WX_WINDOW_H_BASE_
|
2002-03-08 21:58:13 -05:00
|
|
|
|