]> git.saurik.com Git - wxWidgets.git/blob - include/wx/gtk/window.h
I've now seen 2 or 3 themes that need this extra space in a label-less
[wxWidgets.git] / include / wx / gtk / window.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/gtk/window.h
3 // Purpose:
4 // Author: Robert Roebling
5 // Id: $Id$
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
9
10 #ifndef __GTKWINDOWH__
11 #define __GTKWINDOWH__
12
13 // helper structure that holds class that holds GtkIMContext object and
14 // some additional data needed for key events processing
15 struct wxGtkIMData;
16
17 //-----------------------------------------------------------------------------
18 // callback definition for inserting a window (internal)
19 //-----------------------------------------------------------------------------
20
21 class WXDLLIMPEXP_CORE wxWindowGTK;
22 typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* );
23
24 //-----------------------------------------------------------------------------
25 // wxWindowGTK
26 //-----------------------------------------------------------------------------
27
28 class WXDLLIMPEXP_CORE wxWindowGTK : public wxWindowBase
29 {
30 public:
31 // creating the window
32 // -------------------
33 wxWindowGTK();
34 wxWindowGTK(wxWindow *parent,
35 wxWindowID id,
36 const wxPoint& pos = wxDefaultPosition,
37 const wxSize& size = wxDefaultSize,
38 long style = 0,
39 const wxString& name = wxPanelNameStr);
40 bool Create(wxWindow *parent,
41 wxWindowID id,
42 const wxPoint& pos = wxDefaultPosition,
43 const wxSize& size = wxDefaultSize,
44 long style = 0,
45 const wxString& name = wxPanelNameStr);
46 virtual ~wxWindowGTK();
47
48 // implement base class (pure) virtual methods
49 // -------------------------------------------
50
51 virtual void SetLabel(const wxString& WXUNUSED(label)) { }
52 virtual wxString GetLabel() const { return wxEmptyString; }
53
54 virtual bool Destroy();
55
56 virtual void Raise();
57 virtual void Lower();
58
59 virtual bool Show( bool show = true );
60 virtual bool Enable( bool enable = true );
61
62 virtual void SetWindowStyleFlag( long style );
63
64 virtual bool IsRetained() const;
65
66 virtual void SetFocus();
67 virtual bool AcceptsFocus() const;
68
69 virtual bool Reparent( wxWindowBase *newParent );
70
71 virtual void WarpPointer(int x, int y);
72
73 virtual void Refresh( bool eraseBackground = true,
74 const wxRect *rect = (const wxRect *) NULL );
75 virtual void Update();
76 virtual void ClearBackground();
77
78 virtual bool SetBackgroundColour( const wxColour &colour );
79 virtual bool SetForegroundColour( const wxColour &colour );
80 virtual bool SetCursor( const wxCursor &cursor );
81 virtual bool SetFont( const wxFont &font );
82
83 virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
84
85 virtual int GetCharHeight() const;
86 virtual int GetCharWidth() const;
87 virtual void GetTextExtent(const wxString& string,
88 int *x, int *y,
89 int *descent = (int *) NULL,
90 int *externalLeading = (int *) NULL,
91 const wxFont *theFont = (const wxFont *) NULL)
92 const;
93
94 virtual void SetScrollbar( int orient, int pos, int thumbVisible,
95 int range, bool refresh = true );
96 virtual void SetScrollPos( int orient, int pos, bool refresh = true );
97 virtual int GetScrollPos( int orient ) const;
98 virtual int GetScrollThumb( int orient ) const;
99 virtual int GetScrollRange( int orient ) const;
100 virtual void ScrollWindow( int dx, int dy,
101 const wxRect* rect = (wxRect *) NULL );
102 virtual bool ScrollLines(int lines);
103 virtual bool ScrollPages(int pages);
104
105 #if wxUSE_DRAG_AND_DROP
106 virtual void SetDropTarget( wxDropTarget *dropTarget );
107 #endif // wxUSE_DRAG_AND_DROP
108
109 virtual void AddChild( wxWindowBase *child );
110 virtual void RemoveChild( wxWindowBase *child );
111
112 // implementation
113 // --------------
114
115 virtual WXWidget GetHandle() const { return m_widget; }
116
117 // I don't want users to override what's done in idle so everything that
118 // has to be done in idle time in order for wxGTK to work is done in
119 // OnInternalIdle
120 virtual void OnInternalIdle();
121
122 // Internal represention of Update()
123 void GtkUpdate();
124
125 // For compatibility across platforms (not in event table)
126 void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
127
128 // wxGTK-specific: called recursively by Enable,
129 // to give widgets an opportunity to correct their colours after they
130 // have been changed by Enable
131 virtual void OnParentEnable( bool WXUNUSED(enable) ) {}
132
133 // Used by all window classes in the widget creation process.
134 bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
135 void PostCreation();
136
137 // Internal addition of child windows. differs from class
138 // to class not by using virtual functions but by using
139 // the m_insertCallback.
140 void DoAddChild(wxWindowGTK *child);
141
142 // This methods sends wxPaintEvents to the window. It reads the
143 // update region, breaks it up into rects and sends an event
144 // for each rect. It is also responsible for background erase
145 // events and NC paint events. It is called from "draw" and
146 // "expose" handlers as well as from ::Update()
147 void GtkSendPaintEvents();
148
149 // The methods below are required because many native widgets
150 // are composed of several subwidgets and setting a style for
151 // the widget means setting it for all subwidgets as well.
152 // also, it is not clear which native widget is the top
153 // widget where (most of) the input goes. even tooltips have
154 // to be applied to all subwidgets.
155 virtual GtkWidget* GetConnectWidget();
156 virtual bool IsOwnGtkWindow( GdkWindow *window );
157 void ConnectWidget( GtkWidget *widget );
158
159 protected:
160 // Override GTKWidgetNeedsMnemonic and return true if your
161 // needs to set its mnemonic widget, such as for a
162 // GtkLabel for wxStaticText, then do the actual
163 // setting of the widget inside GTKWidgetDoSetMnemonic
164 virtual bool GTKWidgetNeedsMnemonic() const;
165 virtual void GTKWidgetDoSetMnemonic(GtkWidget* w);
166
167 public:
168 // Returns the default context which usually is anti-aliased
169 PangoContext *GtkGetPangoDefaultContext();
170
171 #if wxUSE_TOOLTIPS
172 virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
173 #endif // wxUSE_TOOLTIPS
174
175 // Called from GTK signal handlers. it indicates that
176 // the layouting functions have to be called later on
177 // (i.e. in idle time, implemented in OnInternalIdle() ).
178 void GtkUpdateSize() { m_sizeSet = false; }
179
180 // fix up the mouse event coords, used by wxListBox only so far
181 virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
182 wxCoord& WXUNUSED(x),
183 wxCoord& WXUNUSED(y)) { }
184
185 // is this window transparent for the mouse events (as wxStaticBox is)?
186 virtual bool IsTransparentForMouse() const { return false; }
187
188 // is this a radiobutton (used by radiobutton code itself only)?
189 virtual bool IsRadioButton() const { return false; }
190
191 // Common scroll event handling code for wxWindow and wxScrollBar
192 wxEventType GetScrollEventType(GtkRange* range);
193
194 void BlockScrollEvent();
195 void UnblockScrollEvent();
196
197 // position and size of the window
198 int m_x, m_y;
199 int m_width, m_height;
200 int m_oldClientWidth,m_oldClientHeight;
201
202 // see the docs in src/gtk/window.cpp
203 GtkWidget *m_widget; // mostly the widget seen by the rest of GTK
204 GtkWidget *m_wxwindow; // mostly the client area as per wxWidgets
205
206 // this widget will be queried for GTK's focus events
207 GtkWidget *m_focusWidget;
208
209 wxGtkIMData *m_imData;
210
211 // horizontal/vertical scroll bar
212 GtkRange* m_scrollBar[2];
213 // horizontal/vertical scroll position
214 double m_scrollPos[2];
215
216 // extra (wxGTK-specific) flags
217 bool m_needParent:1; // ! wxFrame, wxDialog, wxNotebookPage ?
218 bool m_noExpose:1; // wxGLCanvas has its own redrawing
219 bool m_nativeSizeEvent:1; // wxGLCanvas sends wxSizeEvent upon "alloc_size"
220 bool m_hasScrolling:1;
221 bool m_hasVMT:1;
222 bool m_sizeSet:1;
223 bool m_resizing:1;
224 bool m_acceptsFocus:1; // true if not static
225 bool m_hasFocus:1; // true if == FindFocus()
226 bool m_isScrolling:1; // dragging scrollbar thumb?
227 bool m_clipPaintRegion:1; // true after ScrollWindow()
228 bool m_dirtyTabOrder:1; // tab order changed, GTK focus
229 // chain needs update
230 bool m_needsStyleChange:1; // May not be able to change
231 // background style until OnIdle
232 bool m_mouseButtonDown:1;
233 bool m_blockScrollEvent:1;
234
235 // C++ has no virtual methods in the constrcutor of any class but we need
236 // different methods of inserting a child window into a wxFrame,
237 // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
238 wxInsertChildFunction m_insertCallback;
239
240 protected:
241 // implement the base class pure virtuals
242 virtual void DoClientToScreen( int *x, int *y ) const;
243 virtual void DoScreenToClient( int *x, int *y ) const;
244 virtual void DoGetPosition( int *x, int *y ) const;
245 virtual void DoGetSize( int *width, int *height ) const;
246 virtual void DoGetClientSize( int *width, int *height ) const;
247 virtual void DoSetSize(int x, int y,
248 int width, int height,
249 int sizeFlags = wxSIZE_AUTO);
250 virtual void DoSetClientSize(int width, int height);
251 virtual void DoMoveWindow(int x, int y, int width, int height);
252
253 #if wxUSE_MENUS_NATIVE
254 virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
255 #endif // wxUSE_MENUS_NATIVE
256
257 virtual void DoCaptureMouse();
258 virtual void DoReleaseMouse();
259
260 #if wxUSE_TOOLTIPS
261 virtual void DoSetToolTip( wxToolTip *tip );
262 #endif // wxUSE_TOOLTIPS
263
264 // common part of all ctors (not virtual because called from ctor)
265 void Init();
266
267 virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
268
269 // Copies m_children tab order to GTK focus chain:
270 void RealizeTabOrder();
271
272 // Called by ApplyWidgetStyle (which is called by SetFont() and
273 // SetXXXColour etc to apply style changed to native widgets) to create
274 // modified GTK style with non-standard attributes. If forceStyle=true,
275 // creates empty GtkRcStyle if there are no modifications, otherwise
276 // returns NULL in such case.
277 GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
278
279 // Overridden in many GTK widgets who have to handle subwidgets
280 virtual void ApplyWidgetStyle(bool forceStyle = false);
281
282 // helper function to ease native widgets wrapping, called by
283 // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
284 virtual void DoApplyWidgetStyle(GtkRcStyle *style);
285
286 // sets the border of a given GtkScrolledWindow from a wx style
287 static void GtkScrolledWindowSetBorder(GtkWidget* w, int style);
288
289 private:
290 DECLARE_DYNAMIC_CLASS(wxWindowGTK)
291 DECLARE_NO_COPY_CLASS(wxWindowGTK)
292 };
293
294 extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
295
296 #endif // __GTKWINDOWH__