[wxWidgets.git] / include / wx / gtk / window.h

/////////////////////////////////////////////////////////////////////////////
// Name:        window.h
// Purpose:
// Author:      Robert Roebling
// Created:     01/02/97
// Id:
// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////


#ifndef __GTKWINDOWH__
#define __GTKWINDOWH__

#ifdef __GNUG__
#pragma interface
#endif

#include "wx/defs.h"
#include "wx/object.h"
#include "wx/list.h"
#include "wx/event.h"
#include "wx/validate.h"
#include "wx/cursor.h"
#include "wx/font.h"
#include "wx/dc.h"
#include "wx/region.h"
#include "wx/dnd.h"

//-----------------------------------------------------------------------------
// global data
//-----------------------------------------------------------------------------

extern const char *wxFrameNameStr;
extern wxList wxTopLevelWindows;

//-----------------------------------------------------------------------------
// classes
//-----------------------------------------------------------------------------

class wxLayoutConstraints;
class wxSizer;

class wxWindow;
class wxCanvas;

//-----------------------------------------------------------------------------
// global data
//-----------------------------------------------------------------------------

extern const char *wxPanelNameStr;
extern const wxSize wxDefaultSize;
extern const wxPoint wxDefaultPosition;

//-----------------------------------------------------------------------------
// wxWindow
//-----------------------------------------------------------------------------

class wxWindow: public wxEvtHandler
{
public:
  wxWindow();
  wxWindow( wxWindow *parent, wxWindowID id,
    const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
    long style = 0, const wxString &name = wxPanelNameStr );
  bool Create( wxWindow *parent, wxWindowID id,
    const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
    long style = 0, const wxString &name = wxPanelNameStr );
  virtual ~wxWindow();
  bool Close( bool force = FALSE );
  virtual bool Destroy();
  virtual bool DestroyChildren();

  virtual void PrepareDC( wxDC &dc );

  virtual void SetSize( int x, int y, int width, int height,
    int sizeFlags = wxSIZE_AUTO );
  virtual void SetSize( int width, int height );
  virtual void Move( int x, int y );
  virtual void GetSize( int *width, int *height ) const;
  virtual void SetClientSize( int const width, int const height );
  virtual void GetClientSize( int *width, int *height ) const;
  virtual void GetPosition( int *x, int *y ) const;
  virtual void Centre( int direction = wxHORIZONTAL );
  virtual void Fit();

  void OnSize( wxSizeEvent &event );
  void OnIdle( wxIdleEvent& event );

  virtual bool Show( bool show );
  virtual void Enable( bool enable );
  virtual void MakeModal( bool modal );
  virtual bool IsEnabled() const { return m_isEnabled; };
  virtual void SetFocus();
  virtual bool OnClose();

  virtual void AddChild( wxWindow *child );
  wxList *GetChildren();
  virtual void RemoveChild( wxWindow *child );
  void SetReturnCode( int retCode );
  int GetReturnCode();
  wxWindow *GetParent();

  wxEvtHandler *GetEventHandler();
  void SetEventhandler( wxEvtHandler *handler );

  virtual wxValidator *GetValidator();
  virtual void SetValidator( wxValidator *validator );

  bool IsBeingDeleted();

  void SetId( wxWindowID id );
  wxWindowID GetId();

  void SetCursor( const wxCursor &cursor );

  virtual void Refresh( bool eraseBackground = TRUE, const wxRect *rect = NULL );
  virtual void Clear();
  virtual bool IsExposed( long x, long y );
  virtual bool IsExposed( long x, long y, long width, long height );

  virtual wxColour GetBackgroundColour() const;
  virtual void SetBackgroundColour( const wxColour &colour );

  virtual void SetDefaultBackgroundColour( const wxColour& col )
    { m_defaultBackgroundColour = col; };
  virtual wxColour GetDefaultBackgroundColour() const
    { return m_defaultBackgroundColour; };
  virtual void SetDefaultForegroundColour( const wxColour& col )
    { m_defaultForegroundColour = col; };
  virtual wxColour GetDefaultForegroundColour() const
    { return m_defaultForegroundColour; };

  virtual void SetFont( const wxFont &font );
  virtual wxFont *GetFont();
  // For backward compatibility
  inline virtual void SetButtonFont(const wxFont& font) { SetFont(font); }
  inline virtual void SetLabelFont(const wxFont& font) { SetFont(font); }
  inline virtual wxFont *GetLabelFont() { return GetFont(); };
  inline virtual wxFont *GetButtonFont() { return GetFont(); };
  virtual void SetWindowStyleFlag( long flag );
  virtual long GetWindowStyleFlag() const;
  virtual void CaptureMouse();
  virtual void ReleaseMouse();
  virtual void SetTitle( const wxString &title );
  virtual wxString GetTitle() const;
  virtual void SetName( const wxString &name );
  virtual wxString GetName() const;
  virtual wxString GetLabel() const;

  void OnSysColourChanged( wxSysColourChangedEvent &WXUNUSED(event) ) {};

  virtual bool IsShown() const;

  // Raise the window to the top of the Z order
  virtual void Raise(void) {};

  // Lower the window to the bottom of the Z order
  virtual void Lower(void) {};


  virtual bool IsRetained();
  virtual wxWindow *FindWindow( long id );
  virtual wxWindow *FindWindow( const wxString& name );
  void AllowDoubleClick( bool WXUNUSED(allow) ) {};
  void SetDoubleClick( bool WXUNUSED(allow) ) {};
  virtual void ClientToScreen( int *x, int *y );
  virtual void ScreenToClient( int *x, int *y );

  virtual bool Validate();
  virtual bool TransferDataToWindow();
  virtual bool TransferDataFromWindow();
  void OnInitDialog( wxInitDialogEvent &event );
  virtual void InitDialog();
  
  virtual bool PopupMenu( wxMenu *menu, int x, int y );

  virtual void SetDropTarget( wxDropTarget *dropTarget );
  virtual wxDropTarget *GetDropTarget() const;
  
private:
  virtual GtkWidget* GetConnectWidget(void);
  
public:
  virtual void SetScrollbar( int orient, int pos, int thumbVisible,
    int range, bool refresh = TRUE );
  virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
  virtual int GetScrollPos( int orient ) const;
  virtual int GetScrollThumb( int orient ) const;
  virtual int GetScrollRange( int orient ) const;
  virtual void ScrollWindow( int dx, int dy, const wxRect* rect = NULL );

  // return FALSE from here if the window doesn't want the focus
  virtual bool AcceptsFocus() const;

  // update the UI state (called from OnIdle)
  void UpdateWindowUI();

  
public:         // cannot get private going yet

  void PreCreation( wxWindow *parent, wxWindowID id, const wxPoint &pos,
    const wxSize &size, long style, const wxString &name );
  void PostCreation();
  bool HasVMT();
  virtual void ImplementSetSize();
  virtual void ImplementSetPosition();
  void GetDrawingOffset( long *x, long *y );

  wxWindow       *m_parent;
  wxList          m_children;
  int             m_x,m_y;
  int             m_width,m_height;
  int             m_retCode;
  wxEvtHandler   *m_eventHandler;
  wxValidator    *m_windowValidator;
  wxDropTarget   *m_pDropTarget;
  wxWindowID      m_windowId;
  wxCursor       *m_cursor;
  wxFont          m_font;
  wxColour        m_backgroundColour;
  wxColour        m_defaultBackgroundColour;
  wxColour        m_foregroundColour ;
  wxColour        m_defaultForegroundColour;
  wxRegion        m_updateRegion;
  long            m_windowStyle;
  bool            m_isShown;
  bool            m_isEnabled;
  wxString        m_windowName;
  long            m_drawingOffsetX,m_drawingOffsetY;

  GtkWidget      *m_widget;
  GtkWidget      *m_wxwindow;
  GtkAdjustment  *m_hAdjust,*m_vAdjust;
  float           m_oldHorizontalPos;
  float           m_oldVerticalPos;
  bool            m_needParent;
  bool            m_hasScrolling;
  bool            m_hasVMT;
  bool            m_sizeSet;
  bool            m_resizing;

public:  // Layout section

  wxLayoutConstraints * m_constraints;
  wxList *              m_constraintsInvolvedIn;
  wxSizer *             m_windowSizer;
  wxWindow *            m_sizerParent;
  bool                  m_autoLayout;

  wxLayoutConstraints *GetConstraints() const;
  void SetConstraints( wxLayoutConstraints *constraints );
  void SetAutoLayout( bool autoLayout );
  bool GetAutoLayout() const;
  bool Layout();
  void SetSizer( wxSizer *sizer );
  wxSizer *GetSizer() const;
  void SetSizerParent( wxWindow *win );
  wxWindow *GetSizerParent() const;
  void UnsetConstraints(wxLayoutConstraints *c);
  inline wxList *GetConstraintsInvolvedIn() const ;
  void AddConstraintReference(wxWindow *otherWin);
  void RemoveConstraintReference(wxWindow *otherWin);
  void DeleteRelatedConstraints();
  virtual void ResetConstraints();
  virtual void SetConstraintSizes(bool recurse = TRUE);
  virtual bool LayoutPhase1(int *noChanges);
  virtual bool LayoutPhase2(int *noChanges);
  virtual bool DoPhase(int);
  virtual void TransformSizerToActual(int *x, int *y) const ;
  virtual void SizerSetSize(int x, int y, int w, int h);
  virtual void SizerMove(int x, int y);
  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 ;

  DECLARE_DYNAMIC_CLASS(wxWindow)
  DECLARE_EVENT_TABLE()
};

#endif // __GTKWINDOWH__
Commit	Line	Data
c801d85f KB	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: window.h
	3	// Purpose:
	4	// Author: Robert Roebling
	5	// Created: 01/02/97
	6	// Id:
	7	// Copyright: (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
aed8df38	8	// Licence: wxWindows licence
c801d85f KB	9	/////////////////////////////////////////////////////////////////////////////
	10
	11
	12	#ifndef __GTKWINDOWH__
	13	#define __GTKWINDOWH__
	14
	15	#ifdef __GNUG__
	16	#pragma interface
	17	#endif
	18
	19	#include "wx/defs.h"
	20	#include "wx/object.h"
	21	#include "wx/list.h"
	22	#include "wx/event.h"
	23	#include "wx/validate.h"
	24	#include "wx/cursor.h"
	25	#include "wx/font.h"
	26	#include "wx/dc.h"
	27	#include "wx/region.h"
	28	#include "wx/dnd.h"
	29
	30	//-----------------------------------------------------------------------------
	31	// global data
	32	//-----------------------------------------------------------------------------
	33
	34	extern const char *wxFrameNameStr;
	35	extern wxList wxTopLevelWindows;
	36
	37	//-----------------------------------------------------------------------------
	38	// classes
	39	//-----------------------------------------------------------------------------
	40
	41	class wxLayoutConstraints;
	42	class wxSizer;
	43
	44	class wxWindow;
	45	class wxCanvas;
	46
	47	//-----------------------------------------------------------------------------
	48	// global data
	49	//-----------------------------------------------------------------------------
	50
	51	extern const char *wxPanelNameStr;
	52	extern const wxSize wxDefaultSize;
	53	extern const wxPoint wxDefaultPosition;
	54
	55	//-----------------------------------------------------------------------------
	56	// wxWindow
	57	//-----------------------------------------------------------------------------
	58
	59	class wxWindow: public wxEvtHandler
	60	{
aed8df38 VZ	61	public:
	62	wxWindow();
	63	wxWindow( wxWindow *parent, wxWindowID id,
	64	const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
	65	long style = 0, const wxString &name = wxPanelNameStr );
	66	bool Create( wxWindow *parent, wxWindowID id,
	67	const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
	68	long style = 0, const wxString &name = wxPanelNameStr );
	69	virtual ~wxWindow();
	70	bool Close( bool force = FALSE );
	71	virtual bool Destroy();
	72	virtual bool DestroyChildren();
	73
	74	virtual void PrepareDC( wxDC &dc );
	75
	76	virtual void SetSize( int x, int y, int width, int height,
	77	int sizeFlags = wxSIZE_AUTO );
	78	virtual void SetSize( int width, int height );
	79	virtual void Move( int x, int y );
	80	virtual void GetSize( int width, int height ) const;
	81	virtual void SetClientSize( int const width, int const height );
	82	virtual void GetClientSize( int width, int height ) const;
	83	virtual void GetPosition( int x, int y ) const;
	84	virtual void Centre( int direction = wxHORIZONTAL );
	85	virtual void Fit();
	86
	87	void OnSize( wxSizeEvent &event );
	88	void OnIdle( wxIdleEvent& event );
	89
	90	virtual bool Show( bool show );
	91	virtual void Enable( bool enable );
	92	virtual void MakeModal( bool modal );
	93	virtual bool IsEnabled() const { return m_isEnabled; };
	94	virtual void SetFocus();
	95	virtual bool OnClose();
	96
	97	virtual void AddChild( wxWindow *child );
	98	wxList *GetChildren();
	99	virtual void RemoveChild( wxWindow *child );
	100	void SetReturnCode( int retCode );
	101	int GetReturnCode();
	102	wxWindow *GetParent();
	103
	104	wxEvtHandler *GetEventHandler();
	105	void SetEventhandler( wxEvtHandler *handler );
	106
	107	virtual wxValidator *GetValidator();
	108	virtual void SetValidator( wxValidator *validator );
	109
	110	bool IsBeingDeleted();
	111
	112	void SetId( wxWindowID id );
	113	wxWindowID GetId();
	114
	115	void SetCursor( const wxCursor &cursor );
	116
	117	virtual void Refresh( bool eraseBackground = TRUE, const wxRect *rect = NULL );
	118	virtual void Clear();
	119	virtual bool IsExposed( long x, long y );
	120	virtual bool IsExposed( long x, long y, long width, long height );
	121
	122	virtual wxColour GetBackgroundColour() const;
	123	virtual void SetBackgroundColour( const wxColour &colour );
	124
125	virtual void SetDefaultBackgroundColour( const wxColour& col )
126	{ m_defaultBackgroundColour = col; };
127	virtual wxColour GetDefaultBackgroundColour() const
128	{ return m_defaultBackgroundColour; };
129	virtual void SetDefaultForegroundColour( const wxColour& col )
130	{ m_defaultForegroundColour = col; };
131	virtual wxColour GetDefaultForegroundColour() const
132	{ return m_defaultForegroundColour; };
133
134	virtual void SetFont( const wxFont &font );
135	virtual wxFont *GetFont();
136	// For backward compatibility
137	inline virtual void SetButtonFont(const wxFont& font) { SetFont(font); }
138	inline virtual void SetLabelFont(const wxFont& font) { SetFont(font); }
139	inline virtual wxFont *GetLabelFont() { return GetFont(); };
140	inline virtual wxFont *GetButtonFont() { return GetFont(); };
141	virtual void SetWindowStyleFlag( long flag );
142	virtual long GetWindowStyleFlag() const;
143	virtual void CaptureMouse();
144	virtual void ReleaseMouse();
145	virtual void SetTitle( const wxString &title );
146	virtual wxString GetTitle() const;
147	virtual void SetName( const wxString &name );
148	virtual wxString GetName() const;
149	virtual wxString GetLabel() const;
c801d85f	150
aed8df38 VZ	151	void OnSysColourChanged( wxSysColourChangedEvent &WXUNUSED(event) ) {};
	152
	153	virtual bool IsShown() const;
e149aaeb KB	154
	155	// Raise the window to the top of the Z order
	156	virtual void Raise(void) {};
	157
	158	// Lower the window to the bottom of the Z order
	159	virtual void Lower(void) {};
	160
	161
aed8df38 VZ	162	virtual bool IsRetained();
	163	virtual wxWindow *FindWindow( long id );
	164	virtual wxWindow *FindWindow( const wxString& name );
	165	void AllowDoubleClick( bool WXUNUSED(allow) ) {};
	166	void SetDoubleClick( bool WXUNUSED(allow) ) {};
	167	virtual void ClientToScreen( int x, int y );
	168	virtual void ScreenToClient( int x, int y );
	169
	170	virtual bool Validate();
	171	virtual bool TransferDataToWindow();
	172	virtual bool TransferDataFromWindow();
	173	void OnInitDialog( wxInitDialogEvent &event );
	174	virtual void InitDialog();
30dea054 RR	175
30dea054 RR	176	virtual bool PopupMenu( wxMenu *menu, int x, int y );
aed8df38 VZ	177
	178	virtual void SetDropTarget( wxDropTarget *dropTarget );
	179	virtual wxDropTarget *GetDropTarget() const;
30dea054	180
e3e65dac	181	private:
30dea054	182	virtual GtkWidget* GetConnectWidget(void);
e3e65dac RR	183
e3e65dac RR	184	public:
aed8df38 VZ	185	virtual void SetScrollbar( int orient, int pos, int thumbVisible,
	186	int range, bool refresh = TRUE );
	187	virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
	188	virtual int GetScrollPos( int orient ) const;
	189	virtual int GetScrollThumb( int orient ) const;
	190	virtual int GetScrollRange( int orient ) const;
	191	virtual void ScrollWindow( int dx, int dy, const wxRect* rect = NULL );
	192
	193	// return FALSE from here if the window doesn't want the focus
	194	virtual bool AcceptsFocus() const;
	195
	196	// update the UI state (called from OnIdle)
	197	void UpdateWindowUI();
	198
e3e65dac	199
aed8df38 VZ	200	public: // cannot get private going yet
	201
	202	void PreCreation( wxWindow *parent, wxWindowID id, const wxPoint &pos,
	203	const wxSize &size, long style, const wxString &name );
	204	void PostCreation();
	205	bool HasVMT();
	206	virtual void ImplementSetSize();
	207	virtual void ImplementSetPosition();
	208	void GetDrawingOffset( long x, long y );
	209
	210	wxWindow *m_parent;
	211	wxList m_children;
	212	int m_x,m_y;
	213	int m_width,m_height;
	214	int m_retCode;
	215	wxEvtHandler *m_eventHandler;
	216	wxValidator *m_windowValidator;
	217	wxDropTarget *m_pDropTarget;
	218	wxWindowID m_windowId;
	219	wxCursor *m_cursor;
	220	wxFont m_font;
	221	wxColour m_backgroundColour;
	222	wxColour m_defaultBackgroundColour;
	223	wxColour m_foregroundColour ;
	224	wxColour m_defaultForegroundColour;
	225	wxRegion m_updateRegion;
	226	long m_windowStyle;
	227	bool m_isShown;
	228	bool m_isEnabled;
	229	wxString m_windowName;
	230	long m_drawingOffsetX,m_drawingOffsetY;
	231
	232	GtkWidget *m_widget;
	233	GtkWidget *m_wxwindow;
	234	GtkAdjustment m_hAdjust,m_vAdjust;
	235	float m_oldHorizontalPos;
	236	float m_oldVerticalPos;
	237	bool m_needParent;
	238	bool m_hasScrolling;
	239	bool m_hasVMT;
	240	bool m_sizeSet;
	241	bool m_resizing;
	242
	243	public: // Layout section
	244
	245	wxLayoutConstraints * m_constraints;
	246	wxList * m_constraintsInvolvedIn;
	247	wxSizer * m_windowSizer;
	248	wxWindow * m_sizerParent;
	249	bool m_autoLayout;
	250
	251	wxLayoutConstraints *GetConstraints() const;
	252	void SetConstraints( wxLayoutConstraints *constraints );
	253	void SetAutoLayout( bool autoLayout );
	254	bool GetAutoLayout() const;
	255	bool Layout();
	256	void SetSizer( wxSizer *sizer );
	257	wxSizer *GetSizer() const;
	258	void SetSizerParent( wxWindow *win );
	259	wxWindow *GetSizerParent() const;
	260	void UnsetConstraints(wxLayoutConstraints *c);
	261	inline wxList *GetConstraintsInvolvedIn() const ;
	262	void AddConstraintReference(wxWindow *otherWin);
	263	void RemoveConstraintReference(wxWindow *otherWin);
264	void DeleteRelatedConstraints();
265	virtual void ResetConstraints();
266	virtual void SetConstraintSizes(bool recurse = TRUE);
267	virtual bool LayoutPhase1(int *noChanges);
268	virtual bool LayoutPhase2(int *noChanges);
269	virtual bool DoPhase(int);
270	virtual void TransformSizerToActual(int x, int y) const ;
271	virtual void SizerSetSize(int x, int y, int w, int h);
272	virtual void SizerMove(int x, int y);
273	virtual void SetSizeConstraint(int x, int y, int w, int h);
274	virtual void MoveConstraint(int x, int y);
275	virtual void GetSizeConstraint(int w, int h) const ;
276	virtual void GetClientSizeConstraint(int w, int h) const ;
277	virtual void GetPositionConstraint(int x, int y) const ;
278
279	DECLARE_DYNAMIC_CLASS(wxWindow)
c801d85f KB	280	DECLARE_EVENT_TABLE()
	281	};
	282
	283	#endif // __GTKWINDOWH__