file used to generate setup.h.in

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

diff --git a/include/wx/gtk/window.h b/include/wx/gtk/window.h
index bd18a96e900319542d50b70f1cfebfb09948b180..aa722a2f14822dd19052cf8b08b1c53219487def 100644 (file)
--- a/include/wx/gtk/window.h
+++ b/include/wx/gtk/window.h
@@ -2,9 +2,8 @@
 // Name:        window.h
 // Purpose:
 // Author:      Robert Roebling
 // Name:        window.h
 // Purpose:
 // Author:      Robert Roebling

-// Created:     01/02/97
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
+// Id:          $Id$
+// Copyright:   (c) 1998 Robert Roebling

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -13,312 +12,228 @@
 #define __GTKWINDOWH__
 
 #ifdef __GNUG__
 #define __GTKWINDOWH__
 
 #ifdef __GNUG__

-#pragma interface
+    #pragma interface

 #endif
 
 #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"
-#include "wx/accel.h"
-
-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
-
-extern const char *wxFrameNameStr;
-extern wxList wxTopLevelWindows;
-
-//-----------------------------------------------------------------------------
-// classes

 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------

-
-class wxLayoutConstraints;
-class wxSizer;
-class wxResourceTable;
-class wxItemResource;
-
-class wxWindow;
-class wxCanvas;
-
-//-----------------------------------------------------------------------------
-// global data
+// callback definition for inserting a window (internal)

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-extern const char *wxPanelNameStr;
-extern const wxSize wxDefaultSize;
-extern const wxPoint wxDefaultPosition;
+typedef void (*wxInsertChildFunction)( wxWindow*, wxWindow* );

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

-class wxWindow: public wxEvtHandler
+class wxWindow : public wxWindowBase

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxWindow)
-  
-public:
-  wxWindow();
-  inline wxWindow(wxWindow *parent, wxWindowID id,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           long style = 0,
-           const wxString& name = wxPanelNameStr)
-  {
-      Create(parent, id, pos, size, style, name);
-  }
-  bool Create(wxWindow *parent, wxWindowID id,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           long style = 0,
-           const wxString& name = wxPanelNameStr);
-  virtual ~wxWindow();
-
-  virtual bool LoadFromResource( wxWindow *parent, const wxString& resourceName, 
-                                 const wxResourceTable *table = (const wxResourceTable *) NULL);
-  virtual wxControl *CreateItem( const wxItemResource *childResource, 
-                                 const wxResourceTable *table = (const wxResourceTable *) NULL);
-
-  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 );
-  inline void Center(int direction = wxHORIZONTAL) { Centre(direction); }
-  virtual void Fit();
-
-  virtual void SetSizeHints( int minW, int minH, int maxW = -1, int maxH = -1, int incW = -1, int incH = -1 );
-
-  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; }
-  inline bool Enabled(void) const { return 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() const
-    { return m_parent; }
-  wxWindow *GetGrandParent(void) const
-    { return (m_parent ? m_parent->m_parent : (wxWindow*)NULL); }
-  void SetParent( wxWindow *p )
-    { m_parent = p; }
-
-  wxEvtHandler *GetEventHandler();
-  void SetEventHandler( wxEvtHandler *handler );
-  void PushEventHandler( wxEvtHandler *handler );
-  wxEvtHandler *PopEventHandler( bool deleteHandler = FALSE );
-
-  virtual wxValidator *GetValidator();
-  virtual void SetValidator( const wxValidator &validator );
-
-  virtual void SetAcceleratorTable( const wxAcceleratorTable& accel );
-  virtual wxAcceleratorTable *GetAcceleratorTable() { return &m_acceleratorTable; }
-  
-  bool IsBeingDeleted();
-
-  void SetId( wxWindowID id );
-  wxWindowID GetId();
-
-  void SetCursor( const wxCursor &cursor );
-
-  virtual void Refresh( bool eraseBackground = TRUE, const wxRect *rect = (const wxRect *) NULL );
-  virtual void Clear();
-  
-  virtual wxRegion GetUpdateRegion() const;
-  virtual bool IsExposed(int x, int y) const;
-  virtual bool IsExposed(int x, int y, int w, int h) const;
-  virtual bool IsExposed(const wxPoint& pt) const;
-  virtual bool IsExposed(const wxRect& rect) const;
-
-  virtual wxColour GetBackgroundColour() const;
-  virtual void SetBackgroundColour( const wxColour &colour );
-  virtual wxColour GetForegroundColour() const;
-  virtual void SetForegroundColour( const wxColour &colour );
-
-  virtual int GetCharHeight(void) const;
-  virtual int GetCharWidth(void) const;
-  virtual void GetTextExtent( const wxString& string, int *x, int *y,
-                             int *descent = (int *) NULL,
-                             int *externalLeading = (int *) NULL,
-                             const wxFont *theFont = (const wxFont *) NULL, bool use16 = FALSE) const;
-
-  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;
-
-  virtual void Raise(void);
-  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;
-
-  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 = (wxRect *) NULL );
-
-  virtual bool AcceptsFocus() const;
-  void UpdateWindowUI();
-
-  // implementation
-  
-  virtual GtkWidget* GetConnectWidget(void);
-  virtual bool IsOwnGtkWindow( GdkWindow *window );
-  void ConnectWidget( GtkWidget *widget );
-  void ConnectDnDWidget( GtkWidget *widget );
-  void DisconnectDnDWidget( GtkWidget *widget );
-
-  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();
-
-  wxWindow            *m_parent;
-  wxList               m_children;
-  int                  m_x,m_y;
-  int                  m_width,m_height;
-  int                  m_minWidth,m_minHeight;
-  int                  m_maxWidth,m_maxHeight;
-  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;
-  wxAcceleratorTable   m_acceleratorTable;
-
-  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_isScrolling;
-  bool                 m_hasOwnStyle;
-  bool                 m_hasVMT;
-  bool                 m_sizeSet;
-  bool                 m_resizing;
+    DECLARE_DYNAMIC_CLASS(wxWindow)

 
 public:
 
 public:

-
-  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_EVENT_TABLE()
+    // creating the window
+    // -------------------
+    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();
+
+    // implement base class (pure) virtual methods
+    // -------------------------------------------
+    virtual bool Destroy();
+
+    virtual void Raise();
+    virtual void Lower();
+
+    virtual bool Show( bool show = TRUE );
+    virtual bool Enable( bool enable = TRUE );
+
+    virtual bool IsRetained() const;
+
+    virtual void SetFocus();
+    virtual bool AcceptsFocus() const;
+
+    virtual bool Reparent( wxWindow *newParent );
+
+    virtual void WarpPointer(int x, int y);
+    virtual void CaptureMouse();
+    virtual void ReleaseMouse();
+
+    virtual void Refresh( bool eraseBackground = TRUE,
+                          const wxRect *rect = (const wxRect *) NULL );
+    virtual void Clear();
+
+    virtual bool SetBackgroundColour( const wxColour &colour );
+    virtual bool SetForegroundColour( const wxColour &colour );
+    virtual bool SetCursor( const wxCursor &cursor );
+    virtual bool SetFont( const wxFont &font );
+
+    virtual int GetCharHeight() const;
+    virtual int GetCharWidth() const;
+    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;
+
+    virtual bool PopupMenu( wxMenu *menu, int x, int y );
+
+    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 = (wxRect *) NULL );
+
+#if wxUSE_DRAG_AND_DROP
+    virtual void SetDropTarget( wxDropTarget *dropTarget );
+#endif // wxUSE_DRAG_AND_DROP
+
+    // implementation
+    // --------------
+
+    virtual WXWidget GetHandle() const { return m_widget; }
+
+    // also sets the global flag
+    void SetScrolling(bool scroll);
+
+    bool HasScrolling() const { return m_hasScrolling; }
+    bool IsScrolling() const { return m_isScrolling; }
+
+    /* I don't want users to override what's done in idle so everything that
+       has to be done in idle time in order for wxGTK to work is done in
+       OnInternalIdle */
+    virtual void OnInternalIdle();
+
+    /* For compatibility across platforms (not in event table) */
+    void OnIdle(wxIdleEvent& WXUNUSED(event)) {};
+
+    /* used by all classes in the widget creation process */
+    void PreCreation( wxWindow *parent, wxWindowID id, const wxPoint &pos,
+            const wxSize &size, long style, const wxString &name );
+    void PostCreation();
+
+    /* internal addition of child windows. differs from class
+       to class not by using virtual functions but by using
+       the m_insertCallback */
+    void DoAddChild(wxWindow *child);
+
+    /* the methods below are required because many native widgets
+       are composed of several subwidgets and setting a style for
+       the widget means setting it for all subwidgets as well.
+       also, it is nor clear, which native widget is the top
+       widget where (most of) the input goes. even tooltips have
+       to be applied to all subwidgets. */
+
+    virtual GtkWidget* GetConnectWidget();
+    virtual bool IsOwnGtkWindow( GdkWindow *window );
+    void ConnectWidget( GtkWidget *widget );
+
+    /* creates a new widget style if none is there
+       and sets m_widgetStyle to this value. */
+    GtkStyle *GetWidgetStyle();
+
+    /* called by SetFont() and SetXXXColour etc */
+    void SetWidgetStyle();
+
+    /* overridden in many GTK widgets */
+    virtual void ApplyWidgetStyle();
+
+#if wxUSE_TOOLTIPS
+    virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
+#endif // wxUSE_TOOLTIPS
+
+    // called from GTK signales handlers. it indicates that
+    // the layouting functions have to be called later on
+    // (i.e. in idle time, implemented in OnInternalIdle() ).
+    void UpdateSize() { m_sizeSet = FALSE; }
+
+    // position and size of the window
+    int                  m_x, m_y;
+    int                  m_width, m_height;
+
+    /* see the docs in src/gtk/window.cpp */
+    GtkWidget           *m_widget;
+    GtkWidget           *m_wxwindow;
+
+    /* scrolling stuff */
+    GtkAdjustment       *m_hAdjust,*m_vAdjust;
+    float                m_oldHorizontalPos;
+    float                m_oldVerticalPos;
+
+    // we need an extra XGC flag set to get exposed
+    // events from overlapping children upon moving
+    // them. this flag will be set in this GC and
+    // the GC will be used in wxWindow::ScrollWindow().
+    GdkGC               *m_scrollGC;
+
+    // extra (wxGTK-specific) flags
+    bool                 m_needParent:1;    /* ! wxFrame, wxDialog, wxNotebookPage ?  */
+    bool                 m_hasScrolling:1;
+    bool                 m_isScrolling:1;
+    bool                 m_hasVMT:1;
+    bool                 m_sizeSet:1;
+    bool                 m_resizing:1;
+    bool                 m_isStaticBox:1;   /* faster than IS_KIND_OF */
+    bool                 m_isFrame:1;       /* faster than IS_KIND_OF */
+    bool                 m_acceptsFocus:1;  /* ! wxStaticBox etc.  */
+
+    // these are true if the style were set before the widget was realized
+    // (typcally in the constructor) but the actual GTK style must not be set
+    // before the widget has been "realized"
+    bool                 m_delayedFont:1;
+    bool                 m_delayedForegroundColour:1;
+    bool                 m_delayedBackgroundColour:1;
+    bool                 m_delayedCursor:1;
+    
+    // the cursor is set in OnInternalIdle(). this fields holds
+    // a reference to the cursor currently set in theGdk window 
+    // so that we don't have to set it more than once
+    wxCursor             m_currentGdkCursor;
+
+    // contains GTK's widgets internal information about non-default widget
+    // font and colours. we create one for each widget that gets any
+    // non-default attribute set via SetFont() or SetForegroundColour() /
+    // SetBackgroundColour().
+    GtkStyle            *m_widgetStyle;
+
+    // C++ has no virtual methods in the constrcutor of any class but we need
+    // different methods of inserting a child window into a wxFrame,
+    // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
+    wxInsertChildFunction  m_insertCallback;
+
+    // implement the base class pure virtuals
+    virtual void DoClientToScreen( int *x, int *y ) const;
+    virtual void DoScreenToClient( int *x, int *y ) const;
+    virtual void DoGetPosition( int *x, int *y ) const;
+    virtual void DoGetSize( int *width, int *height ) const;
+    virtual void DoGetClientSize( int *width, int *height ) const;
+    virtual void DoSetSize(int x, int y,
+                           int width, int height,
+                           int sizeFlags = wxSIZE_AUTO);
+    virtual void DoSetClientSize(int width, int height);
+
+#if wxUSE_TOOLTIPS
+    virtual void DoSetToolTip( wxToolTip *tip );
+#endif // wxUSE_TOOLTIPS
+
+    // common part of all ctors (can't be virtual because called from ctor)
+    void Init();
+
+private:
+    DECLARE_NO_COPY_CLASS(wxWindow);

 };
 
 #endif // __GTKWINDOWH__
 };
 
 #endif // __GTKWINDOWH__