include/wx/gtk/toplevel.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk/toplevel.h
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling, Julian Smart
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_GTK_TOPLEVEL_H_
  11 #define _WX_GTK_TOPLEVEL_H_
  12
  13 //-----------------------------------------------------------------------------
  14 // wxTopLevelWindowGTK
  15 //-----------------------------------------------------------------------------
  16
  17 class WXDLLIMPEXP_CORE wxTopLevelWindowGTK : public wxTopLevelWindowBase
  18 {
  19 public:
  20     // construction
  21     wxTopLevelWindowGTK() { Init(); }
  22     wxTopLevelWindowGTK(wxWindow *parent,
  23                         wxWindowID id,
  24                         const wxString& title,
  25                         const wxPoint& pos = wxDefaultPosition,
  26                         const wxSize& size = wxDefaultSize,
  27                         long style = wxDEFAULT_FRAME_STYLE,
  28                         const wxString& name = wxFrameNameStr)
  29     {
  30         Init();
  31
  32         Create(parent, id, title, pos, size, style, name);
  33     }
  34
  35     bool Create(wxWindow *parent,
  36                 wxWindowID id,
  37                 const wxString& title,
  38                 const wxPoint& pos = wxDefaultPosition,
  39                 const wxSize& size = wxDefaultSize,
  40                 long style = wxDEFAULT_FRAME_STYLE,
  41                 const wxString& name = wxFrameNameStr);
  42
  43     virtual ~wxTopLevelWindowGTK();
  44
  45     // implement base class pure virtuals
  46     virtual void Maximize(bool maximize = true);
  47     virtual bool IsMaximized() const;
  48     virtual void Iconize(bool iconize = true);
  49     virtual bool IsIconized() const;
  50     virtual void SetIcons(const wxIconBundle& icons);
  51     virtual void Restore();
  52
  53     virtual bool EnableCloseButton(bool enable = true);
  54
  55     virtual void ShowWithoutActivating();
  56     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
  57     virtual bool IsFullScreen() const { return m_fsIsShowing; };
  58
  59     virtual bool SetShape(const wxRegion& region);
  60
  61     virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
  62
  63     virtual void SetWindowStyleFlag( long style );
  64
  65     virtual bool Show(bool show = true);
  66
  67     virtual void Raise();
  68
  69     virtual bool IsActive();
  70
  71     virtual void SetTitle( const wxString &title );
  72     virtual wxString GetTitle() const { return m_title; }
  73
  74     virtual bool SetTransparent(wxByte alpha);
  75     virtual bool CanSetTransparent();
  76
  77     // Experimental, to allow help windows to be
  78     // viewable from within modal dialogs
  79     virtual void AddGrab();
  80     virtual void RemoveGrab();
  81     virtual bool IsGrabbed() const { return m_grabbed; }
  82
  83
  84     virtual void Refresh( bool eraseBackground = true,
  85                           const wxRect *rect = (const wxRect *) NULL );
  86
  87     // implementation from now on
  88     // --------------------------
  89
  90     // GTK callbacks
  91     virtual void OnInternalIdle();
  92
  93     // do *not* call this to iconize the frame, this is a private function!
  94     void SetIconizeState(bool iconic);
  95
  96     GtkWidget    *m_mainWidget;
  97
  98     bool          m_fsIsShowing;         /* full screen */
  99     int           m_fsSaveGdkFunc, m_fsSaveGdkDecor;
 100     wxRect        m_fsSaveFrame;
 101
 102     // m_windowStyle translated to GDK's terms
 103     int           m_gdkFunc,
 104                   m_gdkDecor;
 105
 106     // size of WM decorations
 107     wxSize m_decorSize;
 108
 109     // shape of the frame
 110     wxRegion m_shape;
 111
 112     // private gtk_timeout_add result for mimicing wxUSER_ATTENTION_INFO and
 113     // wxUSER_ATTENTION_ERROR difference, -2 for no hint, -1 for ERROR hint, rest for GtkTimeout handle.
 114     int m_urgency_hint;
 115
 116     // return the size of the window without WM decorations
 117     void GTKDoGetSize(int *width, int *height) const;
 118
 119     void GTKUpdateDecorSize(const wxSize& decorSize);
 120
 121 protected:
 122     // give hints to the Window Manager for how the size
 123     // of the TLW can be changed by dragging
 124     virtual void DoSetSizeHints( int minW, int minH,
 125                                  int maxW, int maxH,
 126                                  int incW, int incH);
 127     // common part of all ctors
 128     void Init();
 129
 130     // move the window to the specified location and resize it
 131     virtual void DoMoveWindow(int x, int y, int width, int height);
 132
 133     // take into account WM decorations here
 134     virtual void DoSetSize(int x, int y,
 135                            int width, int height,
 136                            int sizeFlags = wxSIZE_AUTO);
 137
 138     virtual void DoSetClientSize(int width, int height);
 139     virtual void DoGetClientSize(int *width, int *height) const;
 140
 141     // string shown in the title bar
 142     wxString m_title;
 143
 144     bool m_deferShow;
 145
 146 private:
 147     wxSize& GetCachedDecorSize();
 148
 149     // is the frame currently iconized?
 150     bool m_isIconized;
 151
 152     // is the frame currently grabbed explicitly by the application?
 153     bool m_grabbed;
 154
 155     bool m_updateDecorSize;
 156     bool m_deferShowAllowed;
 157 };
 158
 159 #endif // _WX_GTK_TOPLEVEL_H_