1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/gtk/window.h
4 // Author: Robert Roebling
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 #ifndef __GTKWINDOWH__
11 #define __GTKWINDOWH__
13 // helper structure that holds class that holds GtkIMContext object and
14 // some additional data needed for key events processing
17 //-----------------------------------------------------------------------------
18 // callback definition for inserting a window (internal)
19 //-----------------------------------------------------------------------------
21 class WXDLLIMPEXP_CORE wxWindowGTK
;
22 typedef void (*wxInsertChildFunction
)( wxWindowGTK
*, wxWindowGTK
* );
24 //-----------------------------------------------------------------------------
26 //-----------------------------------------------------------------------------
28 class WXDLLIMPEXP_CORE wxWindowGTK
: public wxWindowBase
31 // creating the window
32 // -------------------
34 wxWindowGTK(wxWindow
*parent
,
36 const wxPoint
& pos
= wxDefaultPosition
,
37 const wxSize
& size
= wxDefaultSize
,
39 const wxString
& name
= wxPanelNameStr
);
40 bool Create(wxWindow
*parent
,
42 const wxPoint
& pos
= wxDefaultPosition
,
43 const wxSize
& size
= wxDefaultSize
,
45 const wxString
& name
= wxPanelNameStr
);
46 virtual ~wxWindowGTK();
48 // implement base class (pure) virtual methods
49 // -------------------------------------------
51 virtual void SetLabel( const wxString
&label
) {}
52 virtual wxString
GetLabel() const { return wxEmptyString
; }
54 virtual bool Destroy();
59 virtual bool Show( bool show
= true );
60 virtual bool Enable( bool enable
= true );
62 virtual bool IsRetained() const;
64 virtual void SetFocus();
65 virtual bool AcceptsFocus() const;
67 virtual bool Reparent( wxWindowBase
*newParent
);
69 virtual void WarpPointer(int x
, int y
);
71 virtual void Refresh( bool eraseBackground
= true,
72 const wxRect
*rect
= (const wxRect
*) NULL
);
73 virtual void Update();
74 virtual void ClearBackground();
76 virtual bool SetBackgroundColour( const wxColour
&colour
);
77 virtual bool SetForegroundColour( const wxColour
&colour
);
78 virtual bool SetCursor( const wxCursor
&cursor
);
79 virtual bool SetFont( const wxFont
&font
);
81 virtual bool SetBackgroundStyle(wxBackgroundStyle style
) ;
83 virtual int GetCharHeight() const;
84 virtual int GetCharWidth() const;
85 virtual void GetTextExtent(const wxString
& string
,
87 int *descent
= (int *) NULL
,
88 int *externalLeading
= (int *) NULL
,
89 const wxFont
*theFont
= (const wxFont
*) NULL
)
92 #if wxUSE_MENUS_NATIVE
93 virtual bool DoPopupMenu( wxMenu
*menu
, int x
, int y
);
94 #endif // wxUSE_MENUS_NATIVE
96 virtual void SetScrollbar( int orient
, int pos
, int thumbVisible
,
97 int range
, bool refresh
= true );
98 virtual void SetScrollPos( int orient
, int pos
, bool refresh
= true );
99 virtual int GetScrollPos( int orient
) const;
100 virtual int GetScrollThumb( int orient
) const;
101 virtual int GetScrollRange( int orient
) const;
102 virtual void ScrollWindow( int dx
, int dy
,
103 const wxRect
* rect
= (wxRect
*) NULL
);
105 #if wxUSE_DRAG_AND_DROP
106 virtual void SetDropTarget( wxDropTarget
*dropTarget
);
107 #endif // wxUSE_DRAG_AND_DROP
110 virtual void AddChild( wxWindowBase
*child
);
111 virtual void RemoveChild( wxWindowBase
*child
);
117 virtual WXWidget
GetHandle() const { return m_widget
; }
119 // I don't want users to override what's done in idle so everything that
120 // has to be done in idle time in order for wxGTK to work is done in
122 virtual void OnInternalIdle();
124 // Internal represention of Update()
127 // For compatibility across platforms (not in event table)
128 void OnIdle(wxIdleEvent
& WXUNUSED(event
)) {}
130 // wxGTK-specific: called recursively by Enable,
131 // to give widgets an oppprtunity to correct their colours after they
132 // have been changed by Enable
133 virtual void OnParentEnable( bool WXUNUSED(enable
) ) {}
135 // Used by all window classes in the widget creation process.
136 bool PreCreation( wxWindowGTK
*parent
, const wxPoint
&pos
, const wxSize
&size
);
139 // Internal addition of child windows. differs from class
140 // to class not by using virtual functions but by using
141 // the m_insertCallback.
142 void DoAddChild(wxWindowGTK
*child
);
144 // This methods sends wxPaintEvents to the window. It reads the
145 // update region, breaks it up into rects and sends an event
146 // for each rect. It is also responsible for background erase
147 // events and NC paint events. It is called from "draw" and
148 // "expose" handlers as well as from ::Update()
149 void GtkSendPaintEvents();
151 // The methods below are required because many native widgets
152 // are composed of several subwidgets and setting a style for
153 // the widget means setting it for all subwidgets as well.
154 // also, it is nor clear, which native widget is the top
155 // widget where (most of) the input goes. even tooltips have
156 // to be applied to all subwidgets.
157 virtual GtkWidget
* GetConnectWidget();
158 virtual bool IsOwnGtkWindow( GdkWindow
*window
);
159 void ConnectWidget( GtkWidget
*widget
);
162 // Returns the default context which usually is anti-aliased
163 PangoContext
*GtkGetPangoDefaultContext();
165 // Returns the X11 context which renders on the X11 client
166 // side (which can be remote) and which usually is not
167 // anti-aliased and is thus faster
168 // MR: Now returns the default pango_context for the widget as GtkGetPangoDefaultContext to
169 // not depend on libpangox - which is completely deprecated.
170 //BCI: Remove GtkGetPangoX11Context and m_x11Context completely when symbols may be removed
171 PangoContext
*GtkGetPangoX11Context();
172 PangoContext
*m_x11Context
; // MR: Now unused
176 virtual void ApplyToolTip( GtkTooltips
*tips
, const wxChar
*tip
);
177 #endif // wxUSE_TOOLTIPS
179 // Call after modifing the value of m_hAdjust or m_vAdjust to bring the
180 // scrolbar in sync (this does not generate any wx events)
181 void GtkUpdateScrollbar(int orient
);
183 // Called from GTK signales handlers. it indicates that
184 // the layouting functions have to be called later on
185 // (i.e. in idle time, implemented in OnInternalIdle() ).
186 void GtkUpdateSize() { m_sizeSet
= false; }
188 // fix up the mouse event coords, used by wxListBox only so far
189 virtual void FixUpMouseEvent(GtkWidget
* WXUNUSED(widget
),
190 wxCoord
& WXUNUSED(x
),
191 wxCoord
& WXUNUSED(y
)) { }
193 // is this window transparent for the mouse events (as wxStaticBox is)?
194 virtual bool IsTransparentForMouse() const { return false; }
196 // is this a radiobutton (used by radiobutton code itself only)?
197 virtual bool IsRadioButton() const { return false; }
199 // position and size of the window
201 int m_width
, m_height
;
202 int m_oldClientWidth
,m_oldClientHeight
;
204 // see the docs in src/gtk/window.cpp
205 GtkWidget
*m_widget
; // mostly the widget seen by the rest of GTK
206 GtkWidget
*m_wxwindow
; // mostly the client area as per wxWidgets
208 // this widget will be queried for GTK's focus events
209 GtkWidget
*m_focusWidget
;
212 wxGtkIMData
*m_imData
;
215 // XIM support for wxWidgets
222 // The area to be cleared (and not just refreshed)
223 // We cannot make this distinction under GTK 2.0.
224 wxRegion m_clearRegion
;
228 GtkAdjustment
*m_hAdjust
,*m_vAdjust
;
229 float m_oldHorizontalPos
;
230 float m_oldVerticalPos
;
232 // extra (wxGTK-specific) flags
233 bool m_needParent
:1; // ! wxFrame, wxDialog, wxNotebookPage ?
234 bool m_noExpose
:1; // wxGLCanvas has its own redrawing
235 bool m_nativeSizeEvent
:1; // wxGLCanvas sends wxSizeEvent upon "alloc_size"
236 bool m_hasScrolling
:1;
240 bool m_acceptsFocus
:1; // true if not static
241 bool m_hasFocus
:1; // true if == FindFocus()
242 bool m_isScrolling
:1; // dragging scrollbar thumb?
243 bool m_clipPaintRegion
:1; // true after ScrollWindow()
245 bool m_dirtyTabOrder
:1; // tab order changed, GTK focus
246 // chain needs update
248 bool m_needsStyleChange
:1; // May not be able to change
249 // background style until OnIdle
251 // C++ has no virtual methods in the constrcutor of any class but we need
252 // different methods of inserting a child window into a wxFrame,
253 // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
254 wxInsertChildFunction m_insertCallback
;
256 // implement the base class pure virtuals
257 virtual void DoClientToScreen( int *x
, int *y
) const;
258 virtual void DoScreenToClient( int *x
, int *y
) const;
259 virtual void DoGetPosition( int *x
, int *y
) const;
260 virtual void DoGetSize( int *width
, int *height
) const;
261 virtual void DoGetClientSize( int *width
, int *height
) const;
262 virtual void DoSetSize(int x
, int y
,
263 int width
, int height
,
264 int sizeFlags
= wxSIZE_AUTO
);
265 virtual void DoSetClientSize(int width
, int height
);
266 virtual void DoMoveWindow(int x
, int y
, int width
, int height
);
268 virtual void DoCaptureMouse();
269 virtual void DoReleaseMouse();
272 virtual void DoSetToolTip( wxToolTip
*tip
);
273 #endif // wxUSE_TOOLTIPS
276 // common part of all ctors (not virtual because called from ctor)
280 virtual void DoMoveInTabOrder(wxWindow
*win
, MoveKind move
);
282 // Copies m_children tab order to GTK focus chain:
283 void RealizeTabOrder();
286 // Called by ApplyWidgetStyle (which is called by SetFont() and
287 // SetXXXColour etc to apply style changed to native widgets) to create
288 // modified GTK style with non-standard attributes. If forceStyle=true,
289 // creates empty GtkRcStyle if there are no modifications, otherwise
290 // returns NULL in such case.
291 GtkRcStyle
*CreateWidgetStyle(bool forceStyle
= false);
293 // Overridden in many GTK widgets who have to handle subwidgets
294 virtual void ApplyWidgetStyle(bool forceStyle
= false);
296 // helper function to ease native widgets wrapping, called by
297 // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
298 virtual void DoApplyWidgetStyle(GtkRcStyle
*style
);
301 DECLARE_DYNAMIC_CLASS(wxWindowGTK
)
302 DECLARE_NO_COPY_CLASS(wxWindowGTK
)
305 extern WXDLLIMPEXP_CORE wxWindow
*wxFindFocusedChild(wxWindowGTK
*win
);
307 #endif // __GTKWINDOWH__