include/wx/gtk/window.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        window.h
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10
  11 #ifndef __GTKWINDOWH__
  12 #define __GTKWINDOWH__
  13
  14 #ifdef __GNUG__
  15 #pragma interface
  16 #endif
  17
  18 #include "wx/defs.h"
  19 #include "wx/object.h"
  20 #include "wx/list.h"
  21 #include "wx/event.h"
  22 #include "wx/validate.h"
  23 #include "wx/cursor.h"
  24 #include "wx/font.h"
  25 #include "wx/dc.h"
  26 #include "wx/region.h"
  27 #include "wx/dnd.h"
  28 #include "wx/accel.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 class wxResourceTable;
  44 class wxItemResource;
  45
  46 class wxClientData;
  47 class wxVoidClientData;
  48 class wxWindow;
  49
  50 //-----------------------------------------------------------------------------
  51 // callback definition for inserting a window (internal)
  52 //-----------------------------------------------------------------------------
  53
  54 typedef void (*wxInsertChildFunction)( wxWindow*, wxWindow* );
  55
  56 //-----------------------------------------------------------------------------
  57 // global data
  58 //-----------------------------------------------------------------------------
  59
  60 extern const char *wxPanelNameStr;
  61 extern const wxSize wxDefaultSize;
  62 extern const wxPoint wxDefaultPosition;
  63
  64 //-----------------------------------------------------------------------------
  65 // wxClientData
  66 //-----------------------------------------------------------------------------
  67
  68 class wxClientData
  69 {
  70 public:
  71     wxClientData() { }
  72     virtual ~wxClientData() { }
  73 };
  74
  75 //-----------------------------------------------------------------------------
  76 // wxStringClientData
  77 //-----------------------------------------------------------------------------
  78
  79 class wxStringClientData: public wxClientData
  80 {
  81 public:
  82     wxStringClientData() { }
  83     wxStringClientData( wxString &data ) { m_data = data; }
  84     void SetData( wxString &data ) { m_data = data; }
  85     wxString GetData() const { return m_data; }
  86
  87 private:
  88     wxString  m_data;
  89 };
  90
  91 //-----------------------------------------------------------------------------
  92 // (debug)
  93 //-----------------------------------------------------------------------------
  94
  95 #ifdef __WXDEBUG__
  96
  97 void debug_focus_in( GtkWidget* widget, const char* name, const char* window );
  98
  99 #endif
 100
 101 //-----------------------------------------------------------------------------
 102 // wxWindow
 103 //-----------------------------------------------------------------------------
 104
 105 class wxWindow: public wxEvtHandler
 106 {
 107   DECLARE_DYNAMIC_CLASS(wxWindow)
 108
 109 public:
 110   wxWindow();
 111   wxWindow(wxWindow *parent, wxWindowID id,
 112            const wxPoint& pos = wxDefaultPosition,
 113            const wxSize& size = wxDefaultSize,
 114            long style = 0,
 115            const wxString& name = wxPanelNameStr);
 116   bool Create(wxWindow *parent, wxWindowID id,
 117            const wxPoint& pos = wxDefaultPosition,
 118            const wxSize& size = wxDefaultSize,
 119            long style = 0,
 120            const wxString& name = wxPanelNameStr);
 121   virtual ~wxWindow();
 122
 123   virtual bool LoadFromResource( wxWindow *parent, const wxString& resourceName,
 124                                  const wxResourceTable *table = (const wxResourceTable *) NULL);
 125   virtual wxControl *CreateItem(const wxItemResource* childResource, const wxItemResource* parentResource,
 126                                  const wxResourceTable *table = (const wxResourceTable *) NULL);
 127
 128   bool Close( bool force = FALSE );
 129   virtual bool Destroy();
 130   virtual bool DestroyChildren();
 131
 132   virtual void PrepareDC( wxDC &dc );
 133
 134   virtual void SetSize( int x, int y, int width, int height,
 135     int sizeFlags = wxSIZE_AUTO );
 136   virtual void SetSize( int width, int height );
 137   virtual void Move( int x, int y );
 138   virtual void GetSize( int *width, int *height ) const;
 139   virtual void SetClientSize( int const width, int const height );
 140   virtual void GetClientSize( int *width, int *height ) const;
 141   virtual void GetPosition( int *x, int *y ) const;
 142   virtual void Centre( int direction = wxHORIZONTAL );
 143   inline void Center(int direction = wxHORIZONTAL) { Centre(direction); }
 144   virtual void Fit();
 145
 146   virtual void SetSizeHints( int minW, int minH, int maxW = -1, int maxH = -1, int incW = -1, int incH = -1 );
 147
 148   // Dialog units translations. Implemented in wincmn.cpp.
 149   wxPoint ConvertPixelsToDialog(const wxPoint& pt) ;
 150   wxPoint ConvertDialogToPixels(const wxPoint& pt) ;
 151   inline wxSize ConvertPixelsToDialog(const wxSize& sz)
 152   { wxPoint pt(ConvertPixelsToDialog(wxPoint(sz.x, sz.y))); return wxSize(pt.x, pt.y); }
 153   inline wxSize ConvertDialogToPixels(const wxSize& sz)
 154   { wxPoint pt(ConvertDialogToPixels(wxPoint(sz.x, sz.y))); return wxSize(pt.x, pt.y); }
 155
 156   void OnSize( wxSizeEvent &event );
 157   void OnIdle( wxIdleEvent& event );
 158
 159   virtual bool Show( bool show );
 160   virtual void Enable( bool enable );
 161   virtual void MakeModal( bool modal );
 162   virtual bool IsEnabled() const { return m_isEnabled; }
 163   inline bool Enabled() const { return IsEnabled(); }
 164   virtual bool OnClose();
 165
 166   virtual void SetFocus();
 167   static wxWindow *FindFocus();
 168
 169   virtual void AddChild( wxWindow *child );
 170   wxList& GetChildren() { return m_children; }
 171
 172   virtual void RemoveChild( wxWindow *child );
 173   void SetReturnCode( int retCode );
 174   int GetReturnCode();
 175   wxWindow *GetParent() const
 176     { return m_parent; }
 177   wxWindow *GetGrandParent() const
 178     { return (m_parent ? m_parent->m_parent : (wxWindow*)NULL); }
 179   void SetParent( wxWindow *p )
 180     { m_parent = p; }
 181   virtual wxWindow *ReParent( wxWindow *newParent );
 182
 183   wxEvtHandler *GetEventHandler() const;
 184   void SetEventHandler( wxEvtHandler *handler );
 185   void PushEventHandler( wxEvtHandler *handler );
 186   wxEvtHandler *PopEventHandler( bool deleteHandler = FALSE );
 187
 188   virtual wxValidator *GetValidator();
 189   virtual void SetValidator( const wxValidator &validator );
 190
 191   virtual void SetClientObject( wxClientData *data );
 192   virtual wxClientData *GetClientObject();
 193
 194   virtual void SetClientData( void *data );
 195   virtual void *GetClientData();
 196
 197   virtual void SetAcceleratorTable( const wxAcceleratorTable& accel );
 198   virtual wxAcceleratorTable *GetAcceleratorTable() { return &m_acceleratorTable; }
 199
 200   bool IsBeingDeleted();
 201
 202   void SetId( wxWindowID id );
 203   wxWindowID GetId() const;
 204
 205   void SetCursor( const wxCursor &cursor );
 206
 207   virtual void Refresh( bool eraseBackground = TRUE, const wxRect *rect = (const wxRect *) NULL );
 208   virtual void Clear();
 209
 210   virtual wxRegion GetUpdateRegion() const;
 211   virtual bool IsExposed(int x, int y) const;
 212   virtual bool IsExposed(int x, int y, int w, int h) const;
 213   virtual bool IsExposed(const wxPoint& pt) const;
 214   virtual bool IsExposed(const wxRect& rect) const;
 215
 216   virtual wxColour GetBackgroundColour() const;
 217   virtual void SetBackgroundColour( const wxColour &colour );
 218   virtual wxColour GetForegroundColour() const;
 219   virtual void SetForegroundColour( const wxColour &colour );
 220
 221   virtual int GetCharHeight() const;
 222   virtual int GetCharWidth() const;
 223   virtual void GetTextExtent( const wxString& string, int *x, int *y,
 224                              int *descent = (int *) NULL,
 225                              int *externalLeading = (int *) NULL,
 226                              const wxFont *theFont = (const wxFont *) NULL, bool use16 = FALSE) const;
 227
 228   virtual void SetFont( const wxFont &font );
 229   virtual const wxFont& GetFont() { return m_font; }
 230
 231     // For backward compatibility
 232   inline virtual void SetButtonFont(const wxFont& font) { SetFont(font); }
 233   inline virtual void SetLabelFont(const wxFont& font) { SetFont(font); }
 234   inline virtual const wxFont& GetLabelFont() { return GetFont(); };
 235   inline virtual const wxFont& GetButtonFont() { return GetFont(); };
 236
 237   virtual void SetWindowStyleFlag( long flag );
 238   virtual long GetWindowStyleFlag() const;
 239
 240   virtual void CaptureMouse();
 241   virtual void ReleaseMouse();
 242
 243   virtual void SetTitle( const wxString &title );
 244   virtual wxString GetTitle() const;
 245   virtual void SetName( const wxString &name );
 246   virtual wxString GetName() const;
 247   virtual wxString GetLabel() const;
 248
 249   void OnSysColourChanged( wxSysColourChangedEvent &WXUNUSED(event) ) {};
 250
 251   virtual bool IsShown() const;
 252
 253   virtual void Raise();
 254   virtual void Lower();
 255
 256   virtual bool IsRetained();
 257   virtual wxWindow *FindWindow( long id );
 258   virtual wxWindow *FindWindow( const wxString& name );
 259
 260   void AllowDoubleClick( bool WXUNUSED(allow) ) {};
 261   void SetDoubleClick( bool WXUNUSED(allow) ) {};
 262
 263   virtual void ClientToScreen( int *x, int *y );
 264   virtual void ScreenToClient( int *x, int *y );
 265
 266   virtual bool Validate();
 267   virtual bool TransferDataToWindow();
 268   virtual bool TransferDataFromWindow();
 269   void OnInitDialog( wxInitDialogEvent &event );
 270   virtual void InitDialog();
 271
 272   virtual bool PopupMenu( wxMenu *menu, int x, int y );
 273
 274   virtual void SetDropTarget( wxDropTarget *dropTarget );
 275   virtual wxDropTarget *GetDropTarget() const;
 276
 277   virtual void SetScrollbar( int orient, int pos, int thumbVisible,
 278     int range, bool refresh = TRUE );
 279   virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
 280   virtual int GetScrollPos( int orient ) const;
 281   virtual int GetScrollThumb( int orient ) const;
 282   virtual int GetScrollRange( int orient ) const;
 283   virtual void ScrollWindow( int dx, int dy, const wxRect* rect = (wxRect *) NULL );
 284
 285   virtual bool AcceptsFocus() const;
 286
 287   void UpdateWindowUI();
 288
 289   // implementation
 290
 291           void        PreCreation( wxWindow *parent, wxWindowID id, const wxPoint &pos,
 292                                    const wxSize &size, long style, const wxString &name );
 293           void        PostCreation();
 294   virtual GtkWidget  *GetConnectWidget();
 295   virtual bool        IsOwnGtkWindow( GdkWindow *window );
 296           void        ConnectWidget( GtkWidget *widget );
 297
 298           bool        HasVMT();
 299
 300   virtual wxPoint     GetClientAreaOrigin() const;
 301   virtual void        AdjustForParentClientOrigin( int& x, int& y, int sizeFlags );
 302
 303           GtkStyle   *GetWidgetStyle();
 304           void        SetWidgetStyle();
 305   virtual void        ApplyWidgetStyle();
 306
 307
 308   wxWindow            *m_parent;
 309   wxList               m_children;
 310   int                  m_x,m_y;
 311   int                  m_width,m_height;
 312   int                  m_minWidth,m_minHeight;
 313   int                  m_maxWidth,m_maxHeight;
 314   int                  m_retCode;
 315   wxEvtHandler        *m_eventHandler;
 316   wxValidator         *m_windowValidator;
 317   wxDropTarget        *m_dropTarget;
 318   wxWindowID           m_windowId;
 319   wxCursor            *m_cursor;
 320   wxFont               m_font;
 321   wxColour             m_backgroundColour;
 322   wxColour             m_foregroundColour;
 323   wxRegion             m_updateRegion;
 324   long                 m_windowStyle;
 325   bool                 m_isShown;
 326   bool                 m_isEnabled;
 327   wxString             m_windowName;
 328   wxAcceleratorTable   m_acceleratorTable;
 329   wxClientData        *m_clientObject;
 330   void                *m_clientData;
 331
 332   GtkWidget           *m_widget;
 333   GtkWidget           *m_wxwindow;
 334   GtkAdjustment       *m_hAdjust,*m_vAdjust;
 335   float                m_oldHorizontalPos;
 336   float                m_oldVerticalPos;
 337   bool                 m_needParent;
 338   bool                 m_hasScrolling;
 339   bool                 m_isScrolling;
 340   bool                 m_hasVMT;
 341   bool                 m_sizeSet;
 342   bool                 m_resizing;
 343   GdkGC               *m_scrollGC;
 344   GtkStyle            *m_widgetStyle;
 345   bool                 m_isStaticBox;
 346   bool                 m_acceptsFocus;
 347
 348   wxInsertChildFunction  m_insertCallback;
 349
 350 public:
 351
 352   wxLayoutConstraints *m_constraints;
 353   wxList              *m_constraintsInvolvedIn;
 354   wxSizer             *m_windowSizer;
 355   wxWindow            *m_sizerParent;
 356   bool                 m_autoLayout;
 357
 358   wxLayoutConstraints *GetConstraints() const;
 359   void SetConstraints( wxLayoutConstraints *constraints );
 360   void SetAutoLayout( bool autoLayout );
 361   bool GetAutoLayout() const;
 362   bool Layout();
 363   void SetSizer( wxSizer *sizer );
 364   wxSizer *GetSizer() const;
 365   void SetSizerParent( wxWindow *win );
 366   wxWindow *GetSizerParent() const;
 367   void UnsetConstraints(wxLayoutConstraints *c);
 368   inline wxList *GetConstraintsInvolvedIn() const ;
 369   void AddConstraintReference(wxWindow *otherWin);
 370   void RemoveConstraintReference(wxWindow *otherWin);
 371   void DeleteRelatedConstraints();
 372   virtual void ResetConstraints();
 373   virtual void SetConstraintSizes(bool recurse = TRUE);
 374   virtual bool LayoutPhase1(int *noChanges);
 375   virtual bool LayoutPhase2(int *noChanges);
 376   virtual bool DoPhase(int);
 377   virtual void TransformSizerToActual(int *x, int *y) const ;
 378   virtual void SizerSetSize(int x, int y, int w, int h);
 379   virtual void SizerMove(int x, int y);
 380   virtual void SetSizeConstraint(int x, int y, int w, int h);
 381   virtual void MoveConstraint(int x, int y);
 382   virtual void GetSizeConstraint(int *w, int *h) const ;
 383   virtual void GetClientSizeConstraint(int *w, int *h) const ;
 384   virtual void GetPositionConstraint(int *x, int *y) const ;
 385
 386 private:
 387   DECLARE_EVENT_TABLE()
 388 };
 389
 390 #endif // __GTKWINDOWH__