restructure fullscreen code dealing with hiding bars
[wxWidgets.git] / 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 bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
56 virtual bool IsFullScreen() const { return m_fsIsShowing; };
57
58 virtual bool SetShape(const wxRegion& region);
59
60 virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
61
62 virtual void SetWindowStyleFlag( long style );
63
64 virtual bool Show(bool show = true);
65
66 virtual void Raise();
67
68 virtual bool IsActive();
69
70 virtual void SetTitle( const wxString &title );
71 virtual wxString GetTitle() const { return m_title; }
72
73 virtual bool SetTransparent(wxByte alpha);
74 virtual bool CanSetTransparent();
75
76 // Experimental, to allow help windows to be
77 // viewable from within modal dialogs
78 virtual void AddGrab();
79 virtual void RemoveGrab();
80 virtual bool IsGrabbed() const { return m_grabbed; }
81
82 // implementation from now on
83 // --------------------------
84
85 // GTK callbacks
86 virtual void GtkOnSize();
87 virtual void OnInternalIdle();
88
89 // do *not* call this to iconize the frame, this is a private function!
90 void SetIconizeState(bool iconic);
91
92 int m_miniEdge,
93 m_miniTitle;
94 GtkWidget *m_mainWidget;
95
96 bool m_fsIsShowing; /* full screen */
97 long m_fsSaveGdkFunc, m_fsSaveGdkDecor;
98 wxRect m_fsSaveFrame;
99
100 // m_windowStyle translated to GDK's terms
101 long m_gdkFunc,
102 m_gdkDecor;
103
104 bool m_sizeSet;
105
106 // private gtk_timeout_add result for mimicing wxUSER_ATTENTION_INFO and
107 // wxUSER_ATTENTION_ERROR difference, -2 for no hint, -1 for ERROR hint, rest for GtkTimeout handle.
108 int m_urgency_hint;
109
110 // give hints to the Window Manager for how the size
111 // of the TLW can be changed by dragging
112 virtual void DoSetSizeHints( int minW, int minH,
113 int maxW = wxDefaultCoord, int maxH = wxDefaultCoord,
114 int incW = wxDefaultCoord, int incH = wxDefaultCoord );
115
116 // return the full size of the window without WM decorations
117 void GTKDoGetSize(int *width, int *height) const;
118
119 void GtkUpdateSize() { m_sizeSet = false; }
120
121 protected:
122 // common part of all ctors
123 void Init();
124
125 // move the window to the specified location and resize it
126 virtual void DoMoveWindow(int x, int y, int width, int height);
127
128 // take into account WM decorations here
129 virtual void DoGetSize(int *width, int *height) const;
130 virtual void DoSetSize(int x, int y,
131 int width, int height,
132 int sizeFlags = wxSIZE_AUTO);
133
134 // override these methods to take into account tool/menu/statusbars
135 virtual void DoGetClientSize(int *width, int *height) const;
136
137 // this method takes the size of the window not taking account of
138 // decorations
139 void GTKDoSetSize(int width, int height);
140
141
142 // string shown in the title bar
143 wxString m_title;
144
145 // is the frame currently iconized?
146 bool m_isIconized;
147
148 // is the frame currently grabbed explicitly by the application?
149 bool m_grabbed;
150 };
151
152 #endif // _WX_GTK_TOPLEVEL_H_