1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/gtk/window.h
4 // Author: Robert Roebling
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 #ifndef _WX_GTK_WINDOW_H_
11 #define _WX_GTK_WINDOW_H_
13 #include "wx/dynarray.h"
15 // helper structure that holds class that holds GtkIMContext object and
16 // some additional data needed for key events processing
19 WX_DEFINE_EXPORTED_ARRAY_PTR(GdkWindow
*, wxArrayGdkWindows
);
21 //-----------------------------------------------------------------------------
22 // callback definition for inserting a window (internal)
23 //-----------------------------------------------------------------------------
25 class WXDLLIMPEXP_CORE wxWindowGTK
;
26 typedef void (*wxInsertChildFunction
)( wxWindowGTK
*, wxWindowGTK
* );
28 //-----------------------------------------------------------------------------
30 //-----------------------------------------------------------------------------
32 class WXDLLIMPEXP_CORE wxWindowGTK
: public wxWindowBase
35 // creating the window
36 // -------------------
38 wxWindowGTK(wxWindow
*parent
,
40 const wxPoint
& pos
= wxDefaultPosition
,
41 const wxSize
& size
= wxDefaultSize
,
43 const wxString
& name
= wxPanelNameStr
);
44 bool Create(wxWindow
*parent
,
46 const wxPoint
& pos
= wxDefaultPosition
,
47 const wxSize
& size
= wxDefaultSize
,
49 const wxString
& name
= wxPanelNameStr
);
50 virtual ~wxWindowGTK();
52 // implement base class (pure) virtual methods
53 // -------------------------------------------
55 virtual void SetLabel(const wxString
& WXUNUSED(label
)) { }
56 virtual wxString
GetLabel() const { return wxEmptyString
; }
58 virtual bool Destroy();
63 virtual bool Show( bool show
= true );
64 virtual bool Enable( bool enable
= true );
66 virtual void SetWindowStyleFlag( long style
);
68 virtual bool IsRetained() const;
70 virtual void SetFocus();
71 virtual bool AcceptsFocus() const;
73 virtual bool Reparent( wxWindowBase
*newParent
);
75 virtual void WarpPointer(int x
, int y
);
77 virtual void Refresh( bool eraseBackground
= true,
78 const wxRect
*rect
= (const wxRect
*) NULL
);
79 virtual void Update();
80 virtual void ClearBackground();
82 virtual bool SetBackgroundColour( const wxColour
&colour
);
83 virtual bool SetForegroundColour( const wxColour
&colour
);
84 virtual bool SetCursor( const wxCursor
&cursor
);
85 virtual bool SetFont( const wxFont
&font
);
87 virtual bool SetBackgroundStyle(wxBackgroundStyle style
) ;
89 virtual int GetCharHeight() const;
90 virtual int GetCharWidth() const;
91 virtual void GetTextExtent(const wxString
& string
,
93 int *descent
= (int *) NULL
,
94 int *externalLeading
= (int *) NULL
,
95 const wxFont
*theFont
= (const wxFont
*) NULL
)
98 virtual void SetScrollbar( int orient
, int pos
, int thumbVisible
,
99 int range
, bool refresh
= true );
100 virtual void SetScrollPos( int orient
, int pos
, bool refresh
= true );
101 virtual int GetScrollPos( int orient
) const;
102 virtual int GetScrollThumb( int orient
) const;
103 virtual int GetScrollRange( int orient
) const;
104 virtual void ScrollWindow( int dx
, int dy
,
105 const wxRect
* rect
= (wxRect
*) NULL
);
106 virtual bool ScrollLines(int lines
);
107 virtual bool ScrollPages(int pages
);
109 #if wxUSE_DRAG_AND_DROP
110 virtual void SetDropTarget( wxDropTarget
*dropTarget
);
111 #endif // wxUSE_DRAG_AND_DROP
113 virtual void AddChild( wxWindowBase
*child
);
114 virtual void RemoveChild( wxWindowBase
*child
);
116 // currently wxGTK2-only
117 void SetDoubleBuffered(bool on
);
122 virtual WXWidget
GetHandle() const { return m_widget
; }
124 // many important things are done here, this function must be called
126 virtual void OnInternalIdle();
128 // Internal represention of Update()
131 // For compatibility across platforms (not in event table)
132 void OnIdle(wxIdleEvent
& WXUNUSED(event
)) {}
134 // wxGTK-specific: called recursively by Enable,
135 // to give widgets an opportunity to correct their colours after they
136 // have been changed by Enable
137 virtual void OnParentEnable( bool WXUNUSED(enable
) ) {}
139 // Used by all window classes in the widget creation process.
140 bool PreCreation( wxWindowGTK
*parent
, const wxPoint
&pos
, const wxSize
&size
);
143 // Internal addition of child windows. differs from class
144 // to class not by using virtual functions but by using
145 // the m_insertCallback.
146 void DoAddChild(wxWindowGTK
*child
);
148 // This methods sends wxPaintEvents to the window. It reads the
149 // update region, breaks it up into rects and sends an event
150 // for each rect. It is also responsible for background erase
151 // events and NC paint events. It is called from "draw" and
152 // "expose" handlers as well as from ::Update()
153 void GtkSendPaintEvents();
155 // The methods below are required because many native widgets
156 // are composed of several subwidgets and setting a style for
157 // the widget means setting it for all subwidgets as well.
158 // also, it is not clear which native widget is the top
159 // widget where (most of) the input goes. even tooltips have
160 // to be applied to all subwidgets.
161 virtual GtkWidget
* GetConnectWidget();
162 void ConnectWidget( GtkWidget
*widget
);
164 // Called from several event handlers, if it returns true or false, the
165 // same value should be immediately returned by the handler without doing
166 // anything else. If it returns -1, the handler should continue as usual
167 int GTKCallbackCommonPrologue(struct _GdkEventAny
*event
) const;
170 // Override GTKWidgetNeedsMnemonic and return true if your
171 // needs to set its mnemonic widget, such as for a
172 // GtkLabel for wxStaticText, then do the actual
173 // setting of the widget inside GTKWidgetDoSetMnemonic
174 virtual bool GTKWidgetNeedsMnemonic() const;
175 virtual void GTKWidgetDoSetMnemonic(GtkWidget
* w
);
177 // Get the GdkWindows making part of this window: usually there will be
178 // only one of them in which case it should be returned directly by this
179 // function. If there is more than one GdkWindow (can be the case for
180 // composite widgets), return NULL and fill in the provided array
182 // This is not pure virtual for backwards compatibility but almost
183 // certainly must be overridden in any wxControl-derived class!
184 virtual GdkWindow
*GTKGetWindow(wxArrayGdkWindows
& windows
) const;
186 // Check if the given window makes part of this widget
187 bool GTKIsOwnWindow(GdkWindow
*window
) const;
189 // Set the focus to this window if its setting was delayed because the
190 // widget hadn't been realized when SetFocus() was called
192 // Return true if focus was set to us, false if nothing was done
193 bool GTKSetDelayedFocusIfNeeded();
196 // Returns the default context which usually is anti-aliased
197 PangoContext
*GtkGetPangoDefaultContext();
200 virtual void ApplyToolTip( GtkTooltips
*tips
, const wxChar
*tip
);
201 #endif // wxUSE_TOOLTIPS
203 // Called from GTK signal handlers. it indicates that
204 // the layouting functions have to be called later on
205 // (i.e. in idle time, implemented in OnInternalIdle() ).
206 void GtkUpdateSize() { m_sizeSet
= false; }
209 // Called when a window should delay showing itself
210 // until idle time. This partly mimmicks defered
212 void GtkShowOnIdle() { m_showOnIdle
= true; }
214 // This is called from the various OnInternalIdle methods
215 bool GtkShowFromOnIdle();
217 // fix up the mouse event coords, used by wxListBox only so far
218 virtual void FixUpMouseEvent(GtkWidget
* WXUNUSED(widget
),
219 wxCoord
& WXUNUSED(x
),
220 wxCoord
& WXUNUSED(y
)) { }
222 // is this window transparent for the mouse events (as wxStaticBox is)?
223 virtual bool IsTransparentForMouse() const { return false; }
225 // is this a radiobutton (used by radiobutton code itself only)?
226 virtual bool IsRadioButton() const { return false; }
228 // Common scroll event handling code for wxWindow and wxScrollBar
229 wxEventType
GetScrollEventType(GtkRange
* range
);
231 void BlockScrollEvent();
232 void UnblockScrollEvent();
234 // position and size of the window
236 int m_width
, m_height
;
237 int m_oldClientWidth
,m_oldClientHeight
;
239 // see the docs in src/gtk/window.cpp
240 GtkWidget
*m_widget
; // mostly the widget seen by the rest of GTK
241 GtkWidget
*m_wxwindow
; // mostly the client area as per wxWidgets
243 // this widget will be queried for GTK's focus events
244 GtkWidget
*m_focusWidget
;
246 wxGtkIMData
*m_imData
;
249 // indices for the arrays below
250 enum ScrollDir
{ ScrollDir_Horz
, ScrollDir_Vert
, ScrollDir_Max
};
252 // horizontal/vertical scroll bar
253 GtkRange
* m_scrollBar
[ScrollDir_Max
];
255 // horizontal/vertical scroll position
256 double m_scrollPos
[ScrollDir_Max
];
258 // if true, don't notify about adjustment change (without resetting the
259 // flag, so this has to be done manually)
260 bool m_blockValueChanged
[ScrollDir_Max
];
262 // return the scroll direction index corresponding to the given orientation
263 // (which is wxVERTICAL or wxHORIZONTAL)
264 static ScrollDir
ScrollDirFromOrient(int orient
)
266 return orient
== wxVERTICAL
? ScrollDir_Vert
: ScrollDir_Horz
;
269 // return the orientation for the given scrolling direction
270 static int OrientFromScrollDir(ScrollDir dir
)
272 return dir
== ScrollDir_Horz
? wxHORIZONTAL
: wxVERTICAL
;
275 // find the direction of the given scrollbar (must be one of ours)
276 ScrollDir
ScrollDirFromRange(GtkRange
*range
) const;
279 // extra (wxGTK-specific) flags
280 bool m_needParent
:1; // ! wxFrame, wxDialog, wxNotebookPage ?
281 bool m_noExpose
:1; // wxGLCanvas has its own redrawing
282 bool m_nativeSizeEvent
:1; // wxGLCanvas sends wxSizeEvent upon "alloc_size"
283 bool m_hasScrolling
:1;
287 bool m_acceptsFocus
:1; // true if not static
288 bool m_hasFocus
:1; // true if == FindFocus()
289 bool m_isScrolling
:1; // dragging scrollbar thumb?
290 bool m_clipPaintRegion
:1; // true after ScrollWindow()
291 bool m_dirtyTabOrder
:1; // tab order changed, GTK focus
292 // chain needs update
293 bool m_needsStyleChange
:1; // May not be able to change
294 // background style until OnIdle
295 bool m_mouseButtonDown
:1;
296 bool m_blockScrollEvent
:1;
298 bool m_showOnIdle
:1; // postpone showing the window until idle
300 // C++ has no virtual methods in the constrcutor of any class but we need
301 // different methods of inserting a child window into a wxFrame,
302 // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
303 wxInsertChildFunction m_insertCallback
;
306 // implement the base class pure virtuals
307 virtual void DoClientToScreen( int *x
, int *y
) const;
308 virtual void DoScreenToClient( int *x
, int *y
) const;
309 virtual void DoGetPosition( int *x
, int *y
) const;
310 virtual void DoGetSize( int *width
, int *height
) const;
311 virtual void DoGetClientSize( int *width
, int *height
) const;
312 virtual void DoSetSize(int x
, int y
,
313 int width
, int height
,
314 int sizeFlags
= wxSIZE_AUTO
);
315 virtual void DoSetClientSize(int width
, int height
);
316 virtual void DoMoveWindow(int x
, int y
, int width
, int height
);
318 #if wxUSE_MENUS_NATIVE
319 virtual bool DoPopupMenu( wxMenu
*menu
, int x
, int y
);
320 #endif // wxUSE_MENUS_NATIVE
322 virtual void DoCaptureMouse();
323 virtual void DoReleaseMouse();
326 virtual void DoSetToolTip( wxToolTip
*tip
);
327 #endif // wxUSE_TOOLTIPS
329 // common part of all ctors (not virtual because called from ctor)
332 virtual void DoMoveInTabOrder(wxWindow
*win
, MoveKind move
);
334 // Copies m_children tab order to GTK focus chain:
335 void RealizeTabOrder();
337 // Called by ApplyWidgetStyle (which is called by SetFont() and
338 // SetXXXColour etc to apply style changed to native widgets) to create
339 // modified GTK style with non-standard attributes. If forceStyle=true,
340 // creates empty GtkRcStyle if there are no modifications, otherwise
341 // returns NULL in such case.
342 GtkRcStyle
*CreateWidgetStyle(bool forceStyle
= false);
344 // Overridden in many GTK widgets who have to handle subwidgets
345 virtual void ApplyWidgetStyle(bool forceStyle
= false);
347 // helper function to ease native widgets wrapping, called by
348 // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
349 virtual void DoApplyWidgetStyle(GtkRcStyle
*style
);
351 // sets the border of a given GtkScrolledWindow from a wx style
352 static void GtkScrolledWindowSetBorder(GtkWidget
* w
, int style
);
354 // set the current cursor for all GdkWindows making part of this widget
355 // (see GTKGetWindow)
357 // should be called from OnInternalIdle() if it's overridden
358 void GTKUpdateCursor();
361 enum ScrollUnit
{ ScrollUnit_Line
, ScrollUnit_Page
, ScrollUnit_Max
};
363 // common part of ScrollLines() and ScrollPages() and could be used, in the
364 // future, for horizontal scrolling as well
366 // return true if we scrolled, false otherwise (on error or simply if we
367 // are already at the end)
368 bool DoScrollByUnits(ScrollDir dir
, ScrollUnit unit
, int units
);
371 DECLARE_DYNAMIC_CLASS(wxWindowGTK
)
372 DECLARE_NO_COPY_CLASS(wxWindowGTK
)
375 extern WXDLLIMPEXP_CORE wxWindow
*wxFindFocusedChild(wxWindowGTK
*win
);
377 #endif // _WX_GTK_WINDOW_H_