1 /////////////////////////////////////////////////////////////////////////////
2 // Name:        wx/gtk1/window.h
3 // Purpose:
4 // Author:      Robert Roebling
5 // Id:          $Id: window.h 41810 2006-10-09 16:39:34Z VZ $
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 
SetLabel(const wxString & WXUNUSED (label))51     virtual void SetLabel(const wxString& WXUNUSED(label)) { }
GetLabel()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 #if wxUSE_MENUS_NATIVE
95     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
96 #endif // wxUSE_MENUS_NATIVE
97 
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 
107 #if wxUSE_DRAG_AND_DROP
108     virtual void SetDropTarget( wxDropTarget *dropTarget );
109 #endif // wxUSE_DRAG_AND_DROP
110 
IsDoubleBuffered()111     virtual bool IsDoubleBuffered() const { return false; }
112 
113     // implementation
114     // --------------
115 
GetHandle()116     virtual WXWidget GetHandle() const { return m_widget; }
117 
118     // I don't want users to override what's done in idle so everything that
119     // has to be done in idle time in order for wxGTK to work is done in
120     // OnInternalIdle
121     virtual void OnInternalIdle();
122 
123     // Internal represention of Update()
124     void GtkUpdate();
125 
126     // For compatibility across platforms (not in event table)
OnIdle(wxIdleEvent & WXUNUSED (event))127     void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
128 
129     // wxGTK-specific: called recursively by Enable,
130     // to give widgets an opportunity to correct their colours after they
131     // have been changed by Enable
OnParentEnable(bool WXUNUSED (enable))132     virtual void OnParentEnable( bool WXUNUSED(enable) ) {}
133 
134     // Used by all window classes in the widget creation process.
135     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
136     void PostCreation();
137 
138     // Internal addition of child windows. differs from class
139     // to class not by using virtual functions but by using
140     // the m_insertCallback.
141     void DoAddChild(wxWindowGTK *child);
142 
143     // This methods sends wxPaintEvents to the window. It reads the
144     // update region, breaks it up into rects and sends an event
145     // for each rect. It is also responsible for background erase
146     // events and NC paint events. It is called from "draw" and
147     // "expose" handlers as well as from ::Update()
148     void GtkSendPaintEvents();
149 
150     // The methods below are required because many native widgets
151     // are composed of several subwidgets and setting a style for
152     // the widget means setting it for all subwidgets as well.
153     // also, it is not clear which native widget is the top
154     // widget where (most of) the input goes. even tooltips have
155     // to be applied to all subwidgets.
156     virtual GtkWidget* GetConnectWidget();
157     virtual bool IsOwnGtkWindow( GdkWindow *window );
158     void ConnectWidget( GtkWidget *widget );
159 
160 #if wxUSE_TOOLTIPS
161     virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
162 #endif // wxUSE_TOOLTIPS
163 
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);
167 
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() ).
GtkUpdateSize()171     void GtkUpdateSize() { m_sizeSet = false; }
172 
173     // fix up the mouse event coords, used by wxListBox only so far
FixUpMouseEvent(GtkWidget * WXUNUSED (widget),wxCoord & WXUNUSED (x),wxCoord & WXUNUSED (y))174     virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
175                                  wxCoord& WXUNUSED(x),
176                                  wxCoord& WXUNUSED(y)) { }
177 
178     // is this window transparent for the mouse events (as wxStaticBox is)?
IsTransparentForMouse()179     virtual bool IsTransparentForMouse() const { return false; }
180 
181     // is this a radiobutton (used by radiobutton code itself only)?
IsRadioButton()182     virtual bool IsRadioButton() const { return false; }
183 
184     // position and size of the window
185     int                  m_x, m_y;
186     int                  m_width, m_height;
187     int                  m_oldClientWidth,m_oldClientHeight;
188 
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
192 
193     // this widget will be queried for GTK's focus events
194     GtkWidget           *m_focusWidget;
195 
196 #ifdef HAVE_XIM
197     // XIM support for wxWidgets
198     GdkIC               *m_ic;
199     GdkICAttr           *m_icattr;
200 #endif // HAVE_XIM
201 
202     // The area to be cleared (and not just refreshed)
203     // We cannot make this distinction under GTK 2.0.
204     wxRegion             m_clearRegion;
205 
206     // scrolling stuff
207     GtkAdjustment       *m_hAdjust,*m_vAdjust;
208     float                m_oldHorizontalPos;
209     float                m_oldVerticalPos;
210 
211     // extra (wxGTK-specific) flags
212     bool                 m_needParent:1;        // ! wxFrame, wxDialog, wxNotebookPage ?
213     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
214     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
215     bool                 m_hasScrolling:1;
216     bool                 m_hasVMT:1;
217     bool                 m_sizeSet:1;
218     bool                 m_resizing:1;
219     bool                 m_acceptsFocus:1;      // true if not static
220     bool                 m_hasFocus:1;          // true if == FindFocus()
221     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
222     bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
223     bool                 m_needsStyleChange:1;  // May not be able to change
224                                                 // background style until OnIdle
225 
226     // C++ has no virtual methods in the constrcutor of any class but we need
227     // different methods of inserting a child window into a wxFrame,
228     // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
229     wxInsertChildFunction  m_insertCallback;
230 
231     // implement the base class pure virtuals
232     virtual void DoClientToScreen( int *x, int *y ) const;
233     virtual void DoScreenToClient( int *x, int *y ) const;
234     virtual void DoGetPosition( int *x, int *y ) const;
235     virtual void DoGetSize( int *width, int *height ) const;
236     virtual void DoGetClientSize( int *width, int *height ) const;
237     virtual void DoSetSize(int x, int y,
238                            int width, int height,
239                            int sizeFlags = wxSIZE_AUTO);
240     virtual void DoSetClientSize(int width, int height);
241     virtual void DoMoveWindow(int x, int y, int width, int height);
242 
243     virtual void DoCaptureMouse();
244     virtual void DoReleaseMouse();
245 
246 #if wxUSE_TOOLTIPS
247     virtual void DoSetToolTip( wxToolTip *tip );
248 #endif // wxUSE_TOOLTIPS
249 
250 protected:
251     // common part of all ctors (not virtual because called from ctor)
252     void Init();
253 
254     // Called by ApplyWidgetStyle (which is called by SetFont() and
255     // SetXXXColour etc to apply style changed to native widgets) to create
256     // modified GTK style with non-standard attributes. If forceStyle=true,
257     // creates empty GtkRcStyle if there are no modifications, otherwise
258     // returns NULL in such case.
259     GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
260 
261     // Overridden in many GTK widgets who have to handle subwidgets
262     virtual void ApplyWidgetStyle(bool forceStyle = false);
263 
264     // helper function to ease native widgets wrapping, called by
265     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
266     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
267 
268 private:
269     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
270     DECLARE_NO_COPY_CLASS(wxWindowGTK)
271 };
272 
273 extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
274 
275 #endif // __GTKWINDOWH__
276