1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxWindow class
4 // Author: David Webster
8 // Copyright: (c) AUTHOR
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
16 #pragma interface "window.h"
26 // ---------------------------------------------------------------------------
27 // forward declarations
28 // ---------------------------------------------------------------------------
30 class WXDLLEXPORT wxWindow
;
31 class WXDLLEXPORT wxButton
;
33 #if wxUSE_DRAG_AND_DROP
34 class WXDLLEXPORT wxDropTarget
;
37 #if wxUSE_WX_RESOURCES
38 class WXDLLEXPORT wxResourceTable
;
39 class WXDLLEXPORT wxItemResource
;
42 WXDLLEXPORT_DATA(extern const char*) wxPanelNameStr
;
44 WXDLLEXPORT_DATA(extern const wxSize
) wxDefaultSize
;
45 WXDLLEXPORT_DATA(extern const wxPoint
) wxDefaultPosition
;
47 class WXDLLEXPORT wxWindow
: public wxWindowBase
49 DECLARE_ABSTRACT_CLASS(wxWindow
)
52 friend class wxPaintDC
;
55 wxWindow() { Init(); };
56 inline wxWindow( wxWindow
* parent
58 ,const wxPoint
& pos
= wxDefaultPosition
59 ,const wxSize
& size
= wxDefaultSize
61 ,const wxString
& name
= wxPanelNameStr
65 Create(parent
, id
, pos
, size
, style
, name
);
70 bool Create( wxWindow
* parent
72 ,const wxPoint
& pos
= wxDefaultPosition
73 ,const wxSize
& size
= wxDefaultSize
75 ,const wxString
& name
= wxPanelNameStr
78 // ---------------------------------------------------------------------------
79 // wxWindowBase pure virtual implementations
80 // ---------------------------------------------------------------------------
85 // Set the focus to this window
86 virtual void SetFocus();
87 // Warp the pointer the given position
88 virtual void WarpPointer(int x_pos
, int y_pos
) ;
89 // Capture/release mouse
90 virtual void CaptureMouse();
91 virtual void ReleaseMouse();
92 // Send the window a refresh event
93 virtual void Refresh(bool eraseBack
= TRUE
, const wxRect
*rect
= NULL
);
97 virtual bool SetFont(const wxFont
& f
);
99 virtual int GetCharHeight() const;
100 virtual int GetCharWidth() const;
101 virtual void GetTextExtent( const wxString
& string
105 ,int* externalLeading
= NULL
106 ,const wxFont
* theFont
= NULL
109 // Configure the window's scrollbar
110 virtual void SetScrollbar( int orient
116 virtual void SetScrollPos( int orient
120 virtual int GetScrollPos(int orient
) const;
121 virtual int GetScrollRange(int orient
) const;
122 virtual int GetScrollThumb(int orient
) const;
123 virtual void ScrollWindow( int dx
125 ,const wxRect
* rect
= NULL
127 #if wxUSE_DRAG_AND_DROP
128 void SetDropTarget(wxDropTarget
*pDropTarget
);
130 // coordinates translation
131 virtual void DoClientToScreen( int *x
, int *y
) const;
132 virtual void DoScreenToClient( int *x
, int *y
) const;
134 // retrieve the position/size of the window
135 virtual void DoGetPosition( int *x
, int *y
) const;
136 virtual void DoGetSize( int *width
, int *height
) const;
137 virtual void DoGetClientSize( int *width
, int *height
) const;
139 // this is the virtual function to be overriden in any derived class which
140 // wants to change how SetSize() or Move() works - it is called by all
141 // versions of these functions in the base class
142 virtual void DoSetSize(int x
, int y
,
143 int width
, int height
,
144 int sizeFlags
= wxSIZE_AUTO
);
146 // same as DoSetSize() for the client size
147 virtual void DoSetClientSize(int width
, int height
);
148 virtual bool DoPopupMenu( wxMenu
*menu
, int x
, int y
);
150 // ---------------------------------------------------------------------------
151 // wxWindowBase virtual implementations that need to be overriden
152 // ---------------------------------------------------------------------------
154 // Fit the window around the items
156 // Show or hide the window
157 virtual bool Show(bool show
); // check if base implementation is OK
158 // Enable or disable the window
159 virtual bool Enable(bool enable
); // check if base implementation is OK
161 virtual bool SetCursor(const wxCursor
& cursor
); // check if base implementation is OK
163 // ---------------------------------------------------------------------------
164 // additional functions
165 // ---------------------------------------------------------------------------
167 // Dialog support: override these and call
168 // base class members to add functionality
169 // that can't be done using validators.
170 void SetClientSize( int width
, int height
)
171 { DoSetClientSize(width
, height
); }
173 void SetClientSize( const wxSize
& size
)
174 { DoSetClientSize(size
.x
, size
.y
); }
176 void SetClientSize(const wxRect
& rect
)
177 { SetClientSize( rect
.width
, rect
.height
); }
179 // Validate controls. If returns FALSE,
180 // validation failed: don't quit
181 virtual bool Validate();
183 // Return code for dialogs
184 inline void SetReturnCode(int retCode
);
185 inline int GetReturnCode();
188 // Get the window with the focus
189 static wxWindow
*FindFocus();
191 // Accept files for dragging
192 virtual void DragAcceptFiles(bool accept
);
194 // Most windows have the concept of a label; for frames, this is the
195 // title; for items, this is the label or button text.
196 inline virtual wxString
GetLabel() const { return GetTitle(); }
199 // Caret manipulation
200 virtual void CreateCaret(int w
, int h
);
201 virtual void CreateCaret(const wxBitmap
*bitmap
);
202 virtual void DestroyCaret();
203 virtual void ShowCaret(bool show
);
204 virtual void SetCaretPos(int x
, int y
);
205 virtual void GetCaretPos(int *x
, int *y
) const;
208 // Handle a control command
209 virtual void OnCommand(wxWindow
& win
, wxCommandEvent
& event
);
211 // Get the default button, if there is one
212 inline virtual wxButton
*GetDefaultItem() const;
213 inline virtual void SetDefaultItem(wxButton
*but
);
215 // Override to define new behaviour for default action (e.g. double clicking
217 virtual void OnDefaultAction(wxControl
*initiatingItem
);
219 void OnEraseBackground(wxEraseEvent
& event
);
220 void OnChar(wxKeyEvent
& event
);
221 void OnKeyDown(wxKeyEvent
& event
);
222 void OnKeyUp(wxKeyEvent
& event
);
223 void OnPaint(wxPaintEvent
& event
);
224 void OnIdle(wxIdleEvent
& event
);
228 // ---------------------------------------------------------------------------
230 // ---------------------------------------------------------------------------
232 // For implementation purposes - sometimes decorations make the client area
234 virtual wxPoint
GetClientAreaOrigin() const;
236 // Makes an adjustment to the window position (for example, a frame that has
237 // a toolbar that it manages itself).
238 virtual void AdjustForParentClientOrigin(int& x
, int& y
, int sizeFlags
);
240 // Executes the default message
241 virtual long Default();
243 /* TODO: you may need something like this
244 // Determine whether 3D effects are wanted
245 virtual WXDWORD Determine3DEffects(WXDWORD defaultBorderStyle, bool *want3D);
248 // Constraint implementation
249 void UnsetConstraints(wxLayoutConstraints
*c
);
250 // Back-pointer to other windows we're involved with, so if we delete
251 // this window, we must delete any constraints we're involved with.
253 wxObject
*GetChild(int number
) const ;
255 // Transfers data to any child controls
256 void OnInitDialog(wxInitDialogEvent
& event
);
266 wxButton
* m_defaultItem
;
271 DECLARE_EVENT_TABLE()
276 ////////////////////////////////////////////////////////////////////////
279 inline wxButton
*wxWindow::GetDefaultItem() const { return m_defaultItem
; }
280 inline void wxWindow::SetDefaultItem(wxButton
*but
) { m_defaultItem
= but
; }
281 inline void wxWindow::SetReturnCode(int retCode
) { m_returnCode
= retCode
; }
282 inline int wxWindow::GetReturnCode() { return m_returnCode
; }
284 // Get the active window.
285 wxWindow
* WXDLLEXPORT
wxGetActiveWindow();