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
& WXUNUSED(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 void SetWindowStyleFlag( long style
);
64 virtual bool IsRetained() const;
66 virtual void SetFocus();
67 virtual bool AcceptsFocus() const;
69 virtual bool Reparent( wxWindowBase
*newParent
);
71 virtual void WarpPointer(int x
, int y
);
73 virtual void Refresh( bool eraseBackground
= true,
74 const wxRect
*rect
= (const wxRect
*) NULL
);
75 virtual void Update();
76 virtual void ClearBackground();
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
);
83 virtual bool SetBackgroundStyle(wxBackgroundStyle style
) ;
85 virtual int GetCharHeight() const;
86 virtual int GetCharWidth() const;
87 virtual void GetTextExtent(const wxString
& string
,
89 int *descent
= (int *) NULL
,
90 int *externalLeading
= (int *) NULL
,
91 const wxFont
*theFont
= (const wxFont
*) NULL
)
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
);
103 #if wxUSE_DRAG_AND_DROP
104 virtual void SetDropTarget( wxDropTarget
*dropTarget
);
105 #endif // wxUSE_DRAG_AND_DROP
107 virtual void AddChild( wxWindowBase
*child
);
108 virtual void RemoveChild( wxWindowBase
*child
);
113 virtual WXWidget
GetHandle() const { return m_widget
; }
115 // I don't want users to override what's done in idle so everything that
116 // has to be done in idle time in order for wxGTK to work is done in
118 virtual void OnInternalIdle();
120 // Internal represention of Update()
123 // For compatibility across platforms (not in event table)
124 void OnIdle(wxIdleEvent
& WXUNUSED(event
)) {}
126 // wxGTK-specific: called recursively by Enable,
127 // to give widgets an opportunity to correct their colours after they
128 // have been changed by Enable
129 virtual void OnParentEnable( bool WXUNUSED(enable
) ) {}
131 // Used by all window classes in the widget creation process.
132 bool PreCreation( wxWindowGTK
*parent
, const wxPoint
&pos
, const wxSize
&size
);
135 // Internal addition of child windows. differs from class
136 // to class not by using virtual functions but by using
137 // the m_insertCallback.
138 void DoAddChild(wxWindowGTK
*child
);
140 // This methods sends wxPaintEvents to the window. It reads the
141 // update region, breaks it up into rects and sends an event
142 // for each rect. It is also responsible for background erase
143 // events and NC paint events. It is called from "draw" and
144 // "expose" handlers as well as from ::Update()
145 void GtkSendPaintEvents();
147 // The methods below are required because many native widgets
148 // are composed of several subwidgets and setting a style for
149 // the widget means setting it for all subwidgets as well.
150 // also, it is not clear which native widget is the top
151 // widget where (most of) the input goes. even tooltips have
152 // to be applied to all subwidgets.
153 virtual GtkWidget
* GetConnectWidget();
154 virtual bool IsOwnGtkWindow( GdkWindow
*window
);
155 void ConnectWidget( GtkWidget
*widget
);
157 // Returns the default context which usually is anti-aliased
158 PangoContext
*GtkGetPangoDefaultContext();
161 virtual void ApplyToolTip( GtkTooltips
*tips
, const wxChar
*tip
);
162 #endif // wxUSE_TOOLTIPS
164 // Call after modifing the value of m_hAdjust or m_vAdjust to bring the
165 // scrolbar in sync (this does not generate any wx events)
166 void GtkUpdateScrollbar(int orient
);
168 // Called from GTK signal handlers. it indicates that
169 // the layouting functions have to be called later on
170 // (i.e. in idle time, implemented in OnInternalIdle() ).
171 void GtkUpdateSize() { m_sizeSet
= false; }
173 // fix up the mouse event coords, used by wxListBox only so far
174 virtual void FixUpMouseEvent(GtkWidget
* WXUNUSED(widget
),
175 wxCoord
& WXUNUSED(x
),
176 wxCoord
& WXUNUSED(y
)) { }
178 // is this window transparent for the mouse events (as wxStaticBox is)?
179 virtual bool IsTransparentForMouse() const { return false; }
181 // is this a radiobutton (used by radiobutton code itself only)?
182 virtual bool IsRadioButton() const { return false; }
184 // position and size of the window
186 int m_width
, m_height
;
187 int m_oldClientWidth
,m_oldClientHeight
;
189 // see the docs in src/gtk/window.cpp
190 GtkWidget
*m_widget
; // mostly the widget seen by the rest of GTK
191 GtkWidget
*m_wxwindow
; // mostly the client area as per wxWidgets
193 // this widget will be queried for GTK's focus events
194 GtkWidget
*m_focusWidget
;
196 wxGtkIMData
*m_imData
;
199 GtkAdjustment
*m_hAdjust
,*m_vAdjust
;
200 float m_oldHorizontalPos
;
201 float m_oldVerticalPos
;
203 // extra (wxGTK-specific) flags
204 bool m_needParent
:1; // ! wxFrame, wxDialog, wxNotebookPage ?
205 bool m_noExpose
:1; // wxGLCanvas has its own redrawing
206 bool m_nativeSizeEvent
:1; // wxGLCanvas sends wxSizeEvent upon "alloc_size"
207 bool m_hasScrolling
:1;
211 bool m_acceptsFocus
:1; // true if not static
212 bool m_hasFocus
:1; // true if == FindFocus()
213 bool m_isScrolling
:1; // dragging scrollbar thumb?
214 bool m_clipPaintRegion
:1; // true after ScrollWindow()
215 bool m_dirtyTabOrder
:1; // tab order changed, GTK focus
216 // chain needs update
217 bool m_needsStyleChange
:1; // May not be able to change
218 // background style until OnIdle
220 // C++ has no virtual methods in the constrcutor of any class but we need
221 // different methods of inserting a child window into a wxFrame,
222 // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
223 wxInsertChildFunction m_insertCallback
;
226 // implement the base class pure virtuals
227 virtual void DoClientToScreen( int *x
, int *y
) const;
228 virtual void DoScreenToClient( int *x
, int *y
) const;
229 virtual void DoGetPosition( int *x
, int *y
) const;
230 virtual void DoGetSize( int *width
, int *height
) const;
231 virtual void DoGetClientSize( int *width
, int *height
) const;
232 virtual void DoSetSize(int x
, int y
,
233 int width
, int height
,
234 int sizeFlags
= wxSIZE_AUTO
);
235 virtual void DoSetClientSize(int width
, int height
);
236 virtual void DoMoveWindow(int x
, int y
, int width
, int height
);
238 #if wxUSE_MENUS_NATIVE
239 virtual bool DoPopupMenu( wxMenu
*menu
, int x
, int y
);
240 #endif // wxUSE_MENUS_NATIVE
242 virtual void DoCaptureMouse();
243 virtual void DoReleaseMouse();
246 virtual void DoSetToolTip( wxToolTip
*tip
);
247 #endif // wxUSE_TOOLTIPS
249 // common part of all ctors (not virtual because called from ctor)
252 virtual void DoMoveInTabOrder(wxWindow
*win
, MoveKind move
);
254 // Copies m_children tab order to GTK focus chain:
255 void RealizeTabOrder();
257 // Called by ApplyWidgetStyle (which is called by SetFont() and
258 // SetXXXColour etc to apply style changed to native widgets) to create
259 // modified GTK style with non-standard attributes. If forceStyle=true,
260 // creates empty GtkRcStyle if there are no modifications, otherwise
261 // returns NULL in such case.
262 GtkRcStyle
*CreateWidgetStyle(bool forceStyle
= false);
264 // Overridden in many GTK widgets who have to handle subwidgets
265 virtual void ApplyWidgetStyle(bool forceStyle
= false);
267 // helper function to ease native widgets wrapping, called by
268 // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
269 virtual void DoApplyWidgetStyle(GtkRcStyle
*style
);
272 DECLARE_DYNAMIC_CLASS(wxWindowGTK
)
273 DECLARE_NO_COPY_CLASS(wxWindowGTK
)
276 extern WXDLLIMPEXP_CORE wxWindow
*wxFindFocusedChild(wxWindowGTK
*win
);
278 #endif // __GTKWINDOWH__