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