include/wx/gtk/window.h

   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
   8 // Licence:     wxWindows licence
   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 #include "wx/accel.h"
  30
  31 //-----------------------------------------------------------------------------
  32 // global data
  33 //-----------------------------------------------------------------------------
  34
  35 extern const char *wxFrameNameStr;
  36 extern wxList wxTopLevelWindows;
  37
  38 //-----------------------------------------------------------------------------
  39 // classes
  40 //-----------------------------------------------------------------------------
  41
  42 class wxLayoutConstraints;
  43 class wxSizer;
  44 class wxResourceTable;
  45 class wxItemResource;
  46
  47 class wxWindow;
  48 class wxCanvas;
  49
  50 //-----------------------------------------------------------------------------
  51 // global data
  52 //-----------------------------------------------------------------------------
  53
  54 extern const char *wxPanelNameStr;
  55 extern const wxSize wxDefaultSize;
  56 extern const wxPoint wxDefaultPosition;
  57
  58 //-----------------------------------------------------------------------------
  59 // wxWindow
  60 //-----------------------------------------------------------------------------
  61
  62 class wxWindow: public wxEvtHandler
  63 {
  64   DECLARE_DYNAMIC_CLASS(wxWindow)
  65
  66 public:
  67   wxWindow();
  68   inline wxWindow(wxWindow *parent, wxWindowID id,
  69            const wxPoint& pos = wxDefaultPosition,
  70            const wxSize& size = wxDefaultSize,
  71            long style = 0,
  72            const wxString& name = wxPanelNameStr)
  73   {
  74       Create(parent, id, pos, size, style, name);
  75   }
  76   bool Create(wxWindow *parent, wxWindowID id,
  77            const wxPoint& pos = wxDefaultPosition,
  78            const wxSize& size = wxDefaultSize,
  79            long style = 0,
  80            const wxString& name = wxPanelNameStr);
  81   virtual ~wxWindow();
  82
  83   virtual bool LoadFromResource( wxWindow *parent, const wxString& resourceName,
  84                                  const wxResourceTable *table = (const wxResourceTable *) NULL);
  85   virtual wxControl *CreateItem(const wxItemResource* childResource, const wxItemResource* parentResource,
  86                                  const wxResourceTable *table = (const wxResourceTable *) NULL);
  87
  88   bool Close( bool force = FALSE );
  89   virtual bool Destroy();
  90   virtual bool DestroyChildren();
  91
  92   virtual void PrepareDC( wxDC &dc );
  93
  94   virtual void SetSize( int x, int y, int width, int height,
  95     int sizeFlags = wxSIZE_AUTO );
  96   virtual void SetSize( int width, int height );
  97   virtual void Move( int x, int y );
  98   virtual void GetSize( int *width, int *height ) const;
  99   virtual void SetClientSize( int const width, int const height );
 100   virtual void GetClientSize( int *width, int *height ) const;
 101   virtual void GetPosition( int *x, int *y ) const;
 102   virtual void Centre( int direction = wxHORIZONTAL );
 103   inline void Center(int direction = wxHORIZONTAL) { Centre(direction); }
 104   virtual void Fit();
 105
 106   virtual void SetSizeHints( int minW, int minH, int maxW = -1, int maxH = -1, int incW = -1, int incH = -1 );
 107
 108   // Dialog units translations. Implemented in wincmn.cpp.
 109   wxPoint ConvertPixelsToDialog(const wxPoint& pt) ;
 110   wxPoint ConvertDialogToPixels(const wxPoint& pt) ;
 111   inline wxSize ConvertPixelsToDialog(const wxSize& sz)
 112   { wxPoint pt(ConvertPixelsToDialog(wxPoint(sz.x, sz.y))); return wxSize(pt.x, pt.y); }
 113   inline wxSize ConvertDialogToPixels(const wxSize& sz)
 114   { wxPoint pt(ConvertDialogToPixels(wxPoint(sz.x, sz.y))); return wxSize(pt.x, pt.y); }
 115
 116   void OnSize( wxSizeEvent &event );
 117   void OnIdle( wxIdleEvent& event );
 118
 119   virtual bool Show( bool show );
 120   virtual void Enable( bool enable );
 121   virtual void MakeModal( bool modal );
 122   virtual bool IsEnabled() const { return m_isEnabled; }
 123   inline bool Enabled(void) const { return IsEnabled(); }
 124   virtual void SetFocus();
 125   virtual bool OnClose();
 126
 127   virtual void AddChild( wxWindow *child );
 128   wxList *GetChildren();
 129   virtual void RemoveChild( wxWindow *child );
 130   void SetReturnCode( int retCode );
 131   int GetReturnCode();
 132   wxWindow *GetParent() const
 133     { return m_parent; }
 134   wxWindow *GetGrandParent(void) const
 135     { return (m_parent ? m_parent->m_parent : (wxWindow*)NULL); }
 136   void SetParent( wxWindow *p )
 137     { m_parent = p; }
 138
 139   wxEvtHandler *GetEventHandler();
 140   void SetEventHandler( wxEvtHandler *handler );
 141   void PushEventHandler( wxEvtHandler *handler );
 142   wxEvtHandler *PopEventHandler( bool deleteHandler = FALSE );
 143
 144   virtual wxValidator *GetValidator();
 145   virtual void SetValidator( const wxValidator &validator );
 146
 147   virtual void SetAcceleratorTable( const wxAcceleratorTable& accel );
 148   virtual wxAcceleratorTable *GetAcceleratorTable() { return &m_acceleratorTable; }
 149
 150   bool IsBeingDeleted();
 151
 152   void SetId( wxWindowID id );
 153   wxWindowID GetId();
 154
 155   void SetCursor( const wxCursor &cursor );
 156
 157   virtual void Refresh( bool eraseBackground = TRUE, const wxRect *rect = (const wxRect *) NULL );
 158   virtual void Clear();
 159
 160   virtual wxRegion GetUpdateRegion() const;
 161   virtual bool IsExposed(int x, int y) const;
 162   virtual bool IsExposed(int x, int y, int w, int h) const;
 163   virtual bool IsExposed(const wxPoint& pt) const;
 164   virtual bool IsExposed(const wxRect& rect) const;
 165
 166   virtual wxColour GetBackgroundColour() const;
 167   virtual void SetBackgroundColour( const wxColour &colour );
 168   virtual wxColour GetForegroundColour() const;
 169   virtual void SetForegroundColour( const wxColour &colour );
 170
 171   virtual int GetCharHeight(void) const;
 172   virtual int GetCharWidth(void) const;
 173   virtual void GetTextExtent( const wxString& string, int *x, int *y,
 174                              int *descent = (int *) NULL,
 175                              int *externalLeading = (int *) NULL,
 176                              const wxFont *theFont = (const wxFont *) NULL, bool use16 = FALSE) const;
 177
 178   virtual void SetFont( const wxFont &font );
 179   virtual wxFont *GetFont();
 180   // For backward compatibility
 181   inline virtual void SetButtonFont(const wxFont& font) { SetFont(font); }
 182   inline virtual void SetLabelFont(const wxFont& font) { SetFont(font); }
 183   inline virtual wxFont *GetLabelFont() { return GetFont(); };
 184   inline virtual wxFont *GetButtonFont() { return GetFont(); };
 185   virtual void SetWindowStyleFlag( long flag );
 186   virtual long GetWindowStyleFlag() const;
 187   virtual void CaptureMouse();
 188   virtual void ReleaseMouse();
 189   virtual void SetTitle( const wxString &title );
 190   virtual wxString GetTitle() const;
 191   virtual void SetName( const wxString &name );
 192   virtual wxString GetName() const;
 193   virtual wxString GetLabel() const;
 194
 195   void OnSysColourChanged( wxSysColourChangedEvent &WXUNUSED(event) ) {};
 196
 197   virtual bool IsShown() const;
 198
 199   virtual void Raise(void);
 200   virtual void Lower(void);
 201
 202   virtual bool IsRetained();
 203   virtual wxWindow *FindWindow( long id );
 204   virtual wxWindow *FindWindow( const wxString& name );
 205   void AllowDoubleClick( bool WXUNUSED(allow) ) {};
 206   void SetDoubleClick( bool WXUNUSED(allow) ) {};
 207   virtual void ClientToScreen( int *x, int *y );
 208   virtual void ScreenToClient( int *x, int *y );
 209
 210   virtual bool Validate();
 211   virtual bool TransferDataToWindow();
 212   virtual bool TransferDataFromWindow();
 213   void OnInitDialog( wxInitDialogEvent &event );
 214   virtual void InitDialog();
 215
 216   virtual bool PopupMenu( wxMenu *menu, int x, int y );
 217
 218   virtual void SetDropTarget( wxDropTarget *dropTarget );
 219   virtual wxDropTarget *GetDropTarget() const;
 220
 221   virtual void SetScrollbar( int orient, int pos, int thumbVisible,
 222     int range, bool refresh = TRUE );
 223   virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
 224   virtual int GetScrollPos( int orient ) const;
 225   virtual int GetScrollThumb( int orient ) const;
 226   virtual int GetScrollRange( int orient ) const;
 227   virtual void ScrollWindow( int dx, int dy, const wxRect* rect = (wxRect *) NULL );
 228
 229   virtual bool AcceptsFocus() const;
 230   void UpdateWindowUI();
 231
 232   // implementation
 233
 234   virtual GtkWidget* GetConnectWidget(void);
 235   virtual bool IsOwnGtkWindow( GdkWindow *window );
 236   void ConnectWidget( GtkWidget *widget );
 237   void ConnectDnDWidget( GtkWidget *widget );
 238   void DisconnectDnDWidget( GtkWidget *widget );
 239
 240   void SetBackgroundColourHelper( GdkWindow *window );
 241
 242   void PreCreation( wxWindow *parent, wxWindowID id, const wxPoint &pos,
 243     const wxSize &size, long style, const wxString &name );
 244   void PostCreation();
 245   bool HasVMT();
 246   virtual void ImplementSetSize();
 247   virtual void ImplementSetPosition();
 248
 249   wxWindow            *m_parent;
 250   wxList               m_children;
 251   int                  m_x,m_y;
 252   int                  m_width,m_height;
 253   int                  m_minWidth,m_minHeight;
 254   int                  m_maxWidth,m_maxHeight;
 255   int                  m_retCode;
 256   wxEvtHandler        *m_eventHandler;
 257   wxValidator         *m_windowValidator;
 258   wxDropTarget        *m_pDropTarget;
 259   wxWindowID           m_windowId;
 260   wxCursor            *m_cursor;
 261   wxFont               m_font;
 262   wxColour             m_backgroundColour;
 263   wxColour             m_foregroundColour ;
 264   wxRegion             m_updateRegion;
 265   long                 m_windowStyle;
 266   bool                 m_isShown;
 267   bool                 m_isEnabled;
 268   wxString             m_windowName;
 269   wxAcceleratorTable   m_acceleratorTable;
 270
 271   GtkWidget           *m_widget;
 272   GtkWidget           *m_wxwindow;
 273   GtkAdjustment       *m_hAdjust,*m_vAdjust;
 274   float                m_oldHorizontalPos;
 275   float                m_oldVerticalPos;
 276   bool                 m_needParent;
 277   bool                 m_hasScrolling;
 278   bool                 m_isScrolling;
 279   bool                 m_hasOwnStyle;
 280   bool                 m_hasVMT;
 281   bool                 m_sizeSet;
 282   bool                 m_resizing;
 283   GdkGC               *m_scrollGC;
 284
 285 public:
 286
 287   wxLayoutConstraints *m_constraints;
 288   wxList              *m_constraintsInvolvedIn;
 289   wxSizer             *m_windowSizer;
 290   wxWindow            *m_sizerParent;
 291   bool                 m_autoLayout;
 292
 293   wxLayoutConstraints *GetConstraints() const;
 294   void SetConstraints( wxLayoutConstraints *constraints );
 295   void SetAutoLayout( bool autoLayout );
 296   bool GetAutoLayout() const;
 297   bool Layout();
 298   void SetSizer( wxSizer *sizer );
 299   wxSizer *GetSizer() const;
 300   void SetSizerParent( wxWindow *win );
 301   wxWindow *GetSizerParent() const;
 302   void UnsetConstraints(wxLayoutConstraints *c);
 303   inline wxList *GetConstraintsInvolvedIn() const ;
 304   void AddConstraintReference(wxWindow *otherWin);
 305   void RemoveConstraintReference(wxWindow *otherWin);
 306   void DeleteRelatedConstraints();
 307   virtual void ResetConstraints();
 308   virtual void SetConstraintSizes(bool recurse = TRUE);
 309   virtual bool LayoutPhase1(int *noChanges);
 310   virtual bool LayoutPhase2(int *noChanges);
 311   virtual bool DoPhase(int);
 312   virtual void TransformSizerToActual(int *x, int *y) const ;
 313   virtual void SizerSetSize(int x, int y, int w, int h);
 314   virtual void SizerMove(int x, int y);
 315   virtual void SetSizeConstraint(int x, int y, int w, int h);
 316   virtual void MoveConstraint(int x, int y);
 317   virtual void GetSizeConstraint(int *w, int *h) const ;
 318   virtual void GetClientSizeConstraint(int *w, int *h) const ;
 319   virtual void GetPositionConstraint(int *x, int *y) const ;
 320
 321 private:
 322   DECLARE_EVENT_TABLE()
 323 };
 324
 325 #endif // __GTKWINDOWH__