git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: window.h
	3	// Purpose: wxWindow class
	4	// Author: Julian Smart
	5	// Modified by:
	6	// Created: 01/02/97
	7	// RCS-ID: $Id$
	8	// Copyright: (c) Julian Smart and Markus Holzem
	9	// Licence: wxWindows licence
	10	/////////////////////////////////////////////////////////////////////////////
	11
	12	#ifndef _WX_WINDOW_H_
	13	#define _WX_WINDOW_H_
	14
	15	// ---------------------------------------------------------------------------
	16	// headers
	17	// ---------------------------------------------------------------------------
	18
	19	#ifdef __GNUG__
	20	#pragma interface "window.h"
	21	#endif
	22
	23	// windows.h #defines the following identifiers which are also used in wxWin
	24	#ifdef GetCharWidth
	25	#undef GetCharWidth
	26	#endif
	27
	28	#ifdef FindWindow
	29	#undef FindWindow
	30	#endif
	31
	32	// VZ: apparently some version of Windows send extra mouse move messages after
	33	// a mouse click. My tests under NT 4.0 and 95 didn't show it so I'm
	34	// tempted to think that it was just an effect of a poor mouse and so the
	35	// code to work around this is currently disabled - just define this as 1
	36	// to reenable it
	37	#define wxUSE_MOUSEEVENT_HACK 0
	38
	39	// ---------------------------------------------------------------------------
	40	// forward declarations
	41	// ---------------------------------------------------------------------------
	42
	43	class WXDLLEXPORT wxButton;
	44
	45	// ---------------------------------------------------------------------------
	46	// constants
	47	// ---------------------------------------------------------------------------
	48
	49	// FIXME does anybody use those? they're unused by wxWindows...
	50	enum
	51	{
	52	wxKEY_SHIFT = 1,
	53	wxKEY_CTRL = 2
	54	};
	55
	56	// ---------------------------------------------------------------------------
	57	// wxWindow declaration for MSW
	58	// ---------------------------------------------------------------------------
	59	class WXDLLEXPORT wxWindow : public wxWindowBase
	60	{
	61	DECLARE_DYNAMIC_CLASS(wxWindow);
	62
	63	public:
	64	wxWindow() { Init(); }
	65
	66	wxWindow(wxWindow *parent,
	67	wxWindowID id,
	68	const wxPoint& pos = wxDefaultPosition,
	69	const wxSize& size = wxDefaultSize,
	70	long style = 0,
	71	const wxString& name = wxPanelNameStr)
	72	{
	73	Init();
	74	Create(parent, id, pos, size, style, name);
	75	}
	76
	77	virtual ~wxWindow();
	78
	79	bool Create(wxWindow *parent,
	80	wxWindowID id,
	81	const wxPoint& pos = wxDefaultPosition,
	82	const wxSize& size = wxDefaultSize,
	83	long style = 0,
	84	const wxString& name = wxPanelNameStr);
	85
	86	// implement base class pure virtuals
	87	virtual void Raise();
	88	virtual void Lower();
	89
	90	virtual bool Show( bool show = TRUE );
	91	virtual bool Enable( bool enable = TRUE );
	92
	93	virtual void SetFocus();
	94
	95	virtual bool Reparent( wxWindow *newParent );
	96
	97	virtual void WarpPointer(int x, int y);
	98	virtual void CaptureMouse();
	99	virtual void ReleaseMouse();
	100
	101	virtual void Refresh( bool eraseBackground = TRUE,
	102	const wxRect rect = (const wxRect ) NULL );
	103	virtual void Clear();
	104
	105	virtual bool SetCursor( const wxCursor &cursor );
	106	virtual bool SetFont( const wxFont &font );
	107
	108	virtual int GetCharHeight() const;
	109	virtual int GetCharWidth() const;
	110	virtual void GetTextExtent(const wxString& string,
	111	int x, int y,
	112	int descent = (int ) NULL,
	113	int externalLeading = (int ) NULL,
	114	const wxFont theFont = (const wxFont ) NULL)
	115	const;
	116
	117	virtual void ClientToScreen( int x, int y ) const;
	118	virtual void ScreenToClient( int x, int y ) const;
	119	wxPoint ClientToScreen(const wxPoint& pt) const
	120	{ int x = pt.x; int y = pt.y; ClientToScreen(& x, & y); return wxPoint(x, y); }
	121	wxPoint ScreenToClient(const wxPoint& pt) const
	122	{ int x = pt.x; int y = pt.y; ScreenToClient(& x, & y); return wxPoint(x, y); }
	123
	124	virtual bool PopupMenu( wxMenu *menu, int x, int y );
	125
	126	virtual void SetScrollbar( int orient, int pos, int thumbVisible,
	127	int range, bool refresh = TRUE );
	128	virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
	129	virtual int GetScrollPos( int orient ) const;
	130	virtual int GetScrollThumb( int orient ) const;
	131	virtual int GetScrollRange( int orient ) const;
	132	virtual void ScrollWindow( int dx, int dy,
	133	const wxRect* rect = (wxRect *) NULL );
	134
	135	#if wxUSE_DRAG_AND_DROP
	136	virtual void SetDropTarget( wxDropTarget *dropTarget );
	137	#endif // wxUSE_DRAG_AND_DROP
	138
	139	// Accept files for dragging
	140	virtual void DragAcceptFiles(bool accept);
	141
	142	#if WXWIN_COMPATIBILITY
	143	// Set/get scroll attributes
	144	virtual void SetScrollRange(int orient, int range, bool refresh = TRUE);
	145	virtual void SetScrollPage(int orient, int page, bool refresh = TRUE);
	146	virtual int OldGetScrollRange(int orient) const;
	147	virtual int GetScrollPage(int orient) const;
	148	#endif // WXWIN_COMPATIBILITY
	149
	150	// caret manipulation (MSW only)
	151	virtual void CreateCaret(int w, int h);
	152	virtual void CreateCaret(const wxBitmap *bitmap);
	153	virtual void DestroyCaret();
	154	virtual void ShowCaret(bool show);
	155	virtual void SetCaretPos(int x, int y);
	156	virtual void GetCaretPos(int x, int y) const;
	157
	158	// event handlers (FIXME: shouldn't they be inside WXWIN_COMPATIBILITY?)
	159	// Handle a control command
	160	virtual void OnCommand(wxWindow& win, wxCommandEvent& event);
	161
	162	// Override to define new behaviour for default action (e.g. double
	163	// clicking on a listbox)
	164	virtual void OnDefaultAction(wxControl *initiatingItem);
	165
	166	// Native resource loading (implemented in src/msw/nativdlg.cpp)
	167	// FIXME: should they really be all virtual?
	168	virtual bool LoadNativeDialog(wxWindow* parent, wxWindowID& id);
	169	virtual bool LoadNativeDialog(wxWindow* parent, const wxString& name);
	170	virtual wxWindow* GetWindowChild1(wxWindowID id);
	171	virtual wxWindow* GetWindowChild(wxWindowID id);
	172
	173	// implementation from now on
	174	// --------------------------
	175
	176	// simple accessors
	177	// ----------------
	178
	179	WXHWND GetHWND() const { return m_hWnd; }
	180	void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
	181	virtual WXWidget GetHandle() const { return GetHWND(); }
	182
	183	bool GetUseCtl3D() const { return m_useCtl3D; }
	184	bool GetTransparentBackground() const { return m_backgroundTransparent; }
	185	void SetTransparent(bool t = TRUE) { m_backgroundTransparent = t; }
	186
	187	// event handlers
	188	// --------------
	189	void OnEraseBackground(wxEraseEvent& event);
	190	void OnIdle(wxIdleEvent& event);
	191
	192	// a window may have a default button
	193	// TODO move into wxPanel and/or wxFrame
	194	wxButton *GetDefaultItem() const { return m_btnDefault; }
	195	void SetDefaultItem(wxButton *btn) { m_btnDefault = btn; }
	196
	197	public:
	198	// For implementation purposes - sometimes decorations make the client area
	199	// smaller
	200	virtual wxPoint GetClientAreaOrigin() const;
	201
	202	// Makes an adjustment to the window position (for example, a frame that has
	203	// a toolbar that it manages itself).
	204	virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags);
	205
	206	// Windows subclassing
	207	void SubclassWin(WXHWND hWnd);
	208	void UnsubclassWin();
	209	virtual bool MSWCommand(WXUINT param, WXWORD id);
	210
	211	WXFARPROC MSWGetOldWndProc() const { return m_oldWndProc; }
	212	void MSWSetOldWndProc(WXFARPROC proc) { m_oldWndProc = proc; }
	213
	214	virtual wxWindow *FindItem(int id) const;
	215	virtual wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const ;
	216	virtual void PreDelete(WXHDC dc); // Allows system cleanup
	217
	218	// Make a Windows extended style from the given wxWindows window style
	219	virtual WXDWORD MakeExtendedStyle(long style, bool eliminateBorders = TRUE);
	220	// Determine whether 3D effects are wanted
	221	virtual WXDWORD Determine3DEffects(WXDWORD defaultBorderStyle, bool *want3D);
	222
	223	// MSW only: TRUE if this control is part of the main control
	224	virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return FALSE; };
	225
	226	wxObject *GetChild(int number) const ;
	227
	228	// returns TRUE if the window has been created
	229	bool MSWCreate(int id,
	230	wxWindow *parent,
	231	const char *wclass,
	232	wxWindow *wx_win,
	233	const char *title,
	234	int x, int y, int width, int height,
	235	WXDWORD style,
	236	const char *dialog_template = NULL,
	237	WXDWORD exendedStyle = 0);
	238
	239	// Actually defined in wx_canvs.cc since requires wxCanvas declaration
	240	virtual void MSWDeviceToLogical(float x, float y) const ;
	241
	242	// Create an appropriate wxWindow from a HWND
	243	virtual wxWindow* CreateWindowFromHWND(wxWindow* parent, WXHWND hWnd);
	244
	245	// Make sure the window style reflects the HWND style (roughly)
	246	virtual void AdoptAttributesFromHWND();
	247
	248	// Setup background and foreground colours correctly
	249	virtual void SetupColours();
	250
	251	// ------------------------------------------------------------------------
	252	// internal handlers for MSW messages: all handlers return a boolen value:
	253	// TRUE means that the handler processed the event and FALSE that it didn't
	254	// ------------------------------------------------------------------------
	255
	256	// TODO: all this should go away, overriding MSWWindowProc() is enough to
	257	// implement this functionality
	258	virtual bool MSWOnCreate(WXLPCREATESTRUCT cs, bool *mayCreate);
	259	virtual bool MSWOnPaint();
	260	virtual bool MSWOnEraseBkgnd(WXHDC pDC);
	261	virtual bool MSWOnSize(int x, int y, WXUINT flag);
	262
	263	virtual bool MSWOnQueryDragIcon(WXHICON *hIcon);
	264	virtual bool MSWOnWindowPosChanging(void *lpPos);
	265
	266	// both horizontal and vertical
	267	virtual bool MSWOnScroll(int orientation, WXWORD nSBCode,
	268	WXWORD pos, WXHWND control);
	269
	270	virtual bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
	271	virtual bool MSWOnSysCommand(WXWPARAM wParam, WXLPARAM lParam);
	272
	273	#ifdef __WIN95__
	274	virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
	275	#endif // __WIN95__
	276
	277	virtual bool MSWOnCtlColor(WXHBRUSH *hBrush,
	278	WXHDC hdc,
	279	WXHWND hWnd,
	280	WXUINT nCtlColor,
	281	WXUINT message,
	282	WXWPARAM wParam,
	283	WXLPARAM lParam);
	284
	285	virtual bool MSWOnPaletteChanged(WXHWND hWndPalChange);
	286	virtual bool MSWOnQueryNewPalette();
	287
	288	virtual bool MSWOnQueryEndSession(long logOff, bool *mayEnd);
	289	virtual bool MSWOnEndSession(bool endSession, long logOff);
	290
	291	virtual bool MSWOnDestroy();
	292	virtual bool MSWOnSetFocus(WXHWND wnd);
	293	virtual bool MSWOnKillFocus(WXHWND wnd);
	294	virtual bool MSWOnDropFiles(WXWPARAM wParam);
	295	virtual bool MSWOnInitDialog(WXHWND hWndFocus);
	296	virtual bool MSWOnShow(bool show, int status);
	297
	298	virtual bool MSWOnMouseEvent(WXUINT msg, int x, int y, WXUINT flags);
	299	virtual bool MSWOnMouseMove(int x, int y, WXUINT flags);
	300
	301	virtual bool MSWOnChar(WXWORD wParam, WXLPARAM lParam, bool isASCII = FALSE);
	302	virtual bool MSWOnKeyDown(WXWORD wParam, WXLPARAM lParam);
	303	virtual bool MSWOnKeyUp(WXWORD wParam, WXLPARAM lParam);
	304
	305	virtual bool MSWOnActivate(int flag, bool minimized, WXHWND activate);
	306	virtual bool MSWOnMDIActivate(long flag, WXHWND activate, WXHWND deactivate);
	307
	308	virtual bool MSWOnDrawItem(int id, WXDRAWITEMSTRUCT *item);
	309	virtual bool MSWOnMeasureItem(int id, WXMEASUREITEMSTRUCT *item);
	310
	311	// Window procedure
	312	virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
	313
	314	// Calls an appropriate default window procedure
	315	virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
	316	virtual bool MSWProcessMessage(WXMSG* pMsg);
	317	virtual bool MSWTranslateMessage(WXMSG* pMsg);
	318	virtual void MSWDestroyWindow();
	319
	320	// Detach "Window" menu from menu bar so it doesn't get deleted
	321	void MSWDetachWindowMenu();
	322
	323	// this function should return the brush to paint the window background
	324	// with or 0 for the default brush
	325	virtual WXHBRUSH OnCtlColor(WXHDC hDC,
	326	WXHWND hWnd,
	327	WXUINT nCtlColor,
	328	WXUINT message,
	329	WXWPARAM wParam,
	330	WXLPARAM lParam);
	331
	332	#if WXWIN_COMPATIBILITY
	333	void SetShowing(bool show) { (void)Show(show); }
	334	bool IsUserEnabled() const { return IsEnabled(); }
	335	#endif // WXWIN_COMPATIBILITY
	336
	337	// Responds to colour changes: passes event on to children.
	338	void OnSysColourChanged(wxSysColourChangedEvent& event);
	339
	340	// initialize various fields of wxMouseEvent (common part of MSWOnMouseXXX)
	341	void InitMouseEvent(wxMouseEvent& event, int x, int y, WXUINT flags);
	342
	343	protected:
	344	// the window handle
	345	WXHWND m_hWnd;
	346
	347	// the old window proc (we subclass all windows)
	348	WXFARPROC m_oldWndProc;
	349
	350	// additional (MSW specific) flags
	351	bool m_useCtl3D:1; // Using CTL3D for this control
	352	bool m_backgroundTransparent:1;
	353	bool m_mouseInWindow:1;
	354	bool m_doubleClickAllowed:1;
	355	bool m_winCaptured:1;
	356
	357	// Caret data
	358	bool m_caretEnabled:1;
	359	bool m_caretShown:1;
	360	int m_caretWidth;
	361	int m_caretHeight;
	362
	363	// the size of one page for scrolling
	364	int m_xThumbSize;
	365	int m_yThumbSize;
	366
	367	#if wxUSE_MOUSEEVENT_HACK
	368	// the coordinates of the last mouse event and the type of it
	369	long m_lastMouseX,
	370	m_lastMouseY;
	371	int m_lastMouseEvent;
	372	#endif // wxUSE_MOUSEEVENT_HACK
	373
	374	WXHMENU m_hMenu; // Menu, if any
	375
	376	wxButton *m_btnDefault;
	377
	378	// implement the base class pure virtuals
	379	virtual void DoGetPosition( int x, int y ) const;
	380	virtual void DoGetSize( int width, int height ) const;
	381	virtual void DoGetClientSize( int width, int height ) const;
	382	virtual void DoSetSize(int x, int y,
	383	int width, int height,
	384	int sizeFlags = wxSIZE_AUTO);
	385	virtual void DoSetClientSize(int width, int height);
	386
	387	#if wxUSE_TOOLTIPS
	388	virtual void DoSetToolTip( wxToolTip *tip );
	389	#endif // wxUSE_TOOLTIPS
	390
	391	private:
	392	// common part of all ctors
	393	void Init();
	394
	395	// the (non-virtual) handlers for the events
	396	bool HandleMove(int x, int y);
	397	bool HandleJoystickEvent(WXUINT msg, int x, int y, WXUINT flags);
	398
	399	#ifdef __WIN95__
	400	bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
	401	#endif // __WIN95__
	402
	403	DECLARE_NO_COPY_CLASS(wxWindow);
	404	DECLARE_EVENT_TABLE()
	405	};
	406
	407	// ---------------------------------------------------------------------------
	408	// global functions
	409	// ---------------------------------------------------------------------------
	410
	411	// kbd code translation
	412	WXDLLEXPORT int wxCharCodeMSWToWX(int keySym);
	413	WXDLLEXPORT int wxCharCodeWXToMSW(int id, bool *IsVirtual);
	414
	415	#endif
	416	// _WX_WINDOW_H_