c4ea29714d
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@12683 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
358 lines
13 KiB
C++
358 lines
13 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: window.h
|
|
// Purpose: wxWindow class
|
|
// Author: Julian Smart
|
|
// Modified by:
|
|
// Created: 17/09/98
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) Julian Smart
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_WINDOW_H_
|
|
#define _WX_WINDOW_H_
|
|
|
|
#ifdef __GNUG__
|
|
#pragma interface "window.h"
|
|
#endif
|
|
|
|
#include "wx/region.h"
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxWindow class for Motif - see also wxWindowBase
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class wxWindow : public wxWindowBase
|
|
{
|
|
friend class WXDLLEXPORT wxDC;
|
|
friend class WXDLLEXPORT wxWindowDC;
|
|
|
|
public:
|
|
wxWindow() { Init(); }
|
|
|
|
wxWindow(wxWindow *parent,
|
|
wxWindowID id,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = 0,
|
|
const wxString& name = wxPanelNameStr)
|
|
{
|
|
Init();
|
|
Create(parent, id, pos, size, style, name);
|
|
}
|
|
|
|
virtual ~wxWindow();
|
|
|
|
bool Create(wxWindow *parent,
|
|
wxWindowID id,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = 0,
|
|
const wxString& name = wxPanelNameStr);
|
|
|
|
// implement base class pure virtuals
|
|
virtual void SetTitle( const wxString& title);
|
|
virtual wxString GetTitle() const;
|
|
|
|
virtual void Raise();
|
|
virtual void Lower();
|
|
|
|
virtual bool Show( bool show = TRUE );
|
|
virtual bool Enable( bool enable = TRUE );
|
|
|
|
virtual void SetFocus();
|
|
|
|
virtual void WarpPointer(int x, int y);
|
|
virtual void CaptureMouse();
|
|
virtual void ReleaseMouse();
|
|
|
|
virtual void Refresh( bool eraseBackground = TRUE,
|
|
const wxRect *rect = (const wxRect *) NULL );
|
|
virtual void Clear();
|
|
|
|
virtual bool SetBackgroundColour( const wxColour &colour );
|
|
virtual bool SetForegroundColour( const wxColour &colour );
|
|
|
|
virtual bool SetCursor( const wxCursor &cursor );
|
|
virtual bool SetFont( const wxFont &font );
|
|
|
|
virtual int GetCharHeight() const;
|
|
virtual int GetCharWidth() const;
|
|
virtual void GetTextExtent(const wxString& string,
|
|
int *x, int *y,
|
|
int *descent = (int *) NULL,
|
|
int *externalLeading = (int *) NULL,
|
|
const wxFont *theFont = (const wxFont *) NULL)
|
|
const;
|
|
|
|
virtual void SetScrollbar( int orient, int pos, int thumbVisible,
|
|
int range, bool refresh = TRUE );
|
|
virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
|
|
virtual int GetScrollPos( int orient ) const;
|
|
virtual int GetScrollThumb( int orient ) const;
|
|
virtual int GetScrollRange( int orient ) const;
|
|
virtual void ScrollWindow( int dx, int dy,
|
|
const wxRect* rect = (wxRect *) NULL );
|
|
|
|
virtual void SetSizeHints(int minW, int minH,
|
|
int maxW = -1, int maxH = -1,
|
|
int incW = -1, int incH = -1);
|
|
#if wxUSE_DRAG_AND_DROP
|
|
virtual void SetDropTarget( wxDropTarget *dropTarget );
|
|
#endif // wxUSE_DRAG_AND_DROP
|
|
|
|
// Accept files for dragging
|
|
virtual void DragAcceptFiles(bool accept);
|
|
|
|
// Get the unique identifier of a window
|
|
virtual WXWidget GetHandle() const { return GetMainWidget(); }
|
|
|
|
// implementation from now on
|
|
// --------------------------
|
|
|
|
// accessors
|
|
// ---------
|
|
|
|
// Get main widget for this window, e.g. a text widget
|
|
virtual WXWidget GetMainWidget() const;
|
|
// Get the widget that corresponds to the label (for font setting, label setting etc.)
|
|
virtual WXWidget GetLabelWidget() const;
|
|
// Get the client widget for this window (something we can create other
|
|
// windows on)
|
|
virtual WXWidget GetClientWidget() const;
|
|
// Get the top widget for this window, e.g. the scrolled widget parent of a
|
|
// multi-line text widget. Top means, top in the window hierarchy that
|
|
// implements this window.
|
|
virtual WXWidget GetTopWidget() const;
|
|
|
|
// Get the underlying X window and display
|
|
WXWindow GetXWindow() const;
|
|
WXDisplay *GetXDisplay() const;
|
|
|
|
// called from Motif callbacks - and should only be called from there
|
|
|
|
void SetButton1(bool pressed) { m_button1Pressed = pressed; }
|
|
void SetButton2(bool pressed) { m_button2Pressed = pressed; }
|
|
void SetButton3(bool pressed) { m_button3Pressed = pressed; }
|
|
|
|
void SetLastClick(int button, long timestamp)
|
|
{ m_lastButton = button; m_lastTS = timestamp; }
|
|
|
|
int GetLastClickedButton() const { return m_lastButton; }
|
|
long GetLastClickTime() const { return m_lastTS; }
|
|
|
|
// Gives window a chance to do something in response to a size message, e.g.
|
|
// arrange status bar, toolbar etc.
|
|
virtual bool PreResize();
|
|
|
|
// Generates a paint event
|
|
virtual void DoPaint();
|
|
|
|
// update rectangle/region manipulation
|
|
// (for wxWindowDC and Motif callbacks only)
|
|
// -----------------------------------------
|
|
|
|
// read/write access to the update rect list
|
|
const wxRectList& GetUpdateRects() const { return m_updateRects; }
|
|
|
|
// Adds a recangle to the updates list
|
|
void AddUpdateRect(int x, int y, int w, int h)
|
|
{ m_updateRects.Append(new wxRect(x, y, w, h)); }
|
|
|
|
// Empties the m_updateRects list
|
|
void ClearUpdateRects();
|
|
|
|
void ClearUpdateRegion() { m_updateRegion.Clear(); }
|
|
void SetUpdateRegion(const wxRegion& region) { m_updateRegion = region; }
|
|
|
|
// sets the fore/background colour for the given widget
|
|
static void DoChangeForegroundColour(WXWidget widget, wxColour& foregroundColour);
|
|
static void DoChangeBackgroundColour(WXWidget widget, wxColour& backgroundColour, bool changeArmColour = FALSE);
|
|
|
|
// For implementation purposes - sometimes decorations make the client area
|
|
// smaller
|
|
virtual wxPoint GetClientAreaOrigin() const;
|
|
|
|
protected:
|
|
// event handlers (not virtual by design)
|
|
void OnIdle(wxIdleEvent& event);
|
|
|
|
// Makes an adjustment to the window position (for example, a frame that has
|
|
// a toolbar that it manages itself).
|
|
virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags);
|
|
|
|
wxWindow *GetChild(int number) const
|
|
{ return GetChildren().Item(number)->GetData(); }
|
|
|
|
// Responds to colour changes: passes event on to children.
|
|
void OnSysColourChanged(wxSysColourChangedEvent& event);
|
|
|
|
// Motif-specific
|
|
|
|
// CanvasXXXSiize functions
|
|
void CanvasGetSize(int* width, int* height) const; // If have drawing area
|
|
void CanvasGetClientSize(int *width, int *height) const;
|
|
void CanvasGetPosition(int *x, int *y) const; // If have drawing area
|
|
void CanvasSetClientSize(int width, int size);
|
|
void CanvasSetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
|
|
|
|
void SetMainWidget(WXWidget w) { m_mainWidget = w; }
|
|
|
|
bool CanAddEventHandler() const { return m_canAddEventHandler; }
|
|
void SetCanAddEventHandler(bool flag) { m_canAddEventHandler = flag; }
|
|
|
|
public:
|
|
WXPixmap GetBackingPixmap() const { return m_backingPixmap; }
|
|
void SetBackingPixmap(WXPixmap pixmap) { m_backingPixmap = pixmap; }
|
|
int GetPixmapWidth() const { return m_pixmapWidth; }
|
|
int GetPixmapHeight() const { return m_pixmapHeight; }
|
|
void SetPixmapWidth(int w) { m_pixmapWidth = w; }
|
|
void SetPixmapHeight(int h) { m_pixmapHeight = h; }
|
|
|
|
// Change properties
|
|
virtual void ChangeFont(bool keepOriginalSize = TRUE); // Change to the current font (often overridden)
|
|
|
|
// Change background and foreground colour using current background colour
|
|
// setting (Motif generates foreground based on background)
|
|
virtual void ChangeBackgroundColour();
|
|
// Change foreground colour using current foreground colour setting
|
|
virtual void ChangeForegroundColour();
|
|
|
|
protected:
|
|
// Adds the widget to the hash table and adds event handlers.
|
|
bool AttachWidget(wxWindow* parent, WXWidget mainWidget,
|
|
WXWidget formWidget, int x, int y, int width, int height);
|
|
bool DetachWidget(WXWidget widget);
|
|
|
|
// How to implement accelerators. If we find a key event, translate to
|
|
// wxWindows wxKeyEvent form. Find a widget for the window. Now find a
|
|
// wxWindow for the widget. If there isn't one, go up the widget hierarchy
|
|
// trying to find one. Once one is found, call ProcessAccelerator for the
|
|
// window. If it returns TRUE (processed the event), skip the X event,
|
|
// otherwise carry on up the wxWindows window hierarchy calling
|
|
// ProcessAccelerator. If all return FALSE, process the X event as normal.
|
|
// Eventually we can implement OnCharHook the same way, but concentrate on
|
|
// accelerators for now. ProcessAccelerator must look at the current
|
|
// accelerator table, and try to find what menu id or window (beneath it)
|
|
// has this ID. Then construct an appropriate command
|
|
// event and send it.
|
|
public:
|
|
virtual bool ProcessAccelerator(wxKeyEvent& event);
|
|
|
|
protected:
|
|
// unmanage and destroy an X widget f it's !NULL (passing NULL is ok)
|
|
void UnmanageAndDestroy(WXWidget widget);
|
|
|
|
// map or unmap an X widget (passing NULL is ok), returns TRUE if widget was
|
|
// mapped/unmapped
|
|
bool MapOrUnmap(WXWidget widget, bool map);
|
|
|
|
// scrolling stuff
|
|
// ---------------
|
|
|
|
// create/destroy window scrollbars
|
|
void CreateScrollbar(wxOrientation orientation);
|
|
void DestroyScrollbar(wxOrientation orientation);
|
|
|
|
// get either hor or vert scrollbar widget
|
|
WXWidget GetScrollbar(wxOrientation orient) const
|
|
{ return orient == wxHORIZONTAL ? m_hScrollBar : m_vScrollBar; }
|
|
|
|
// set the scroll pos
|
|
void SetInternalScrollPos(wxOrientation orient, int pos)
|
|
{
|
|
if ( orient == wxHORIZONTAL )
|
|
m_scrollPosX = pos;
|
|
else
|
|
m_scrollPosY = pos;
|
|
}
|
|
|
|
// Motif-specific flags
|
|
// --------------------
|
|
|
|
bool m_needsRefresh:1; // repaint backing store?
|
|
bool m_canAddEventHandler:1; // ???
|
|
bool m_button1Pressed:1;
|
|
bool m_button2Pressed:1;
|
|
bool m_button3Pressed:1;
|
|
|
|
// For double-click detection
|
|
long m_lastTS; // last timestamp
|
|
int m_lastButton; // last pressed button
|
|
|
|
// List of wxRects representing damaged region
|
|
wxRectList m_updateRects;
|
|
|
|
protected:
|
|
WXWidget m_mainWidget;
|
|
WXWidget m_hScrollBar;
|
|
WXWidget m_vScrollBar;
|
|
WXWidget m_borderWidget;
|
|
WXWidget m_scrolledWindow;
|
|
WXWidget m_drawingArea;
|
|
bool m_winCaptured;
|
|
bool m_hScroll;
|
|
bool m_vScroll;
|
|
WXPixmap m_backingPixmap;
|
|
int m_pixmapWidth;
|
|
int m_pixmapHeight;
|
|
int m_pixmapOffsetX;
|
|
int m_pixmapOffsetY;
|
|
|
|
// Store the last scroll pos, since in wxWin the pos isn't set automatically
|
|
// by system
|
|
int m_scrollPosX;
|
|
int m_scrollPosY;
|
|
|
|
// implement the base class pure virtuals
|
|
virtual void DoClientToScreen( int *x, int *y ) const;
|
|
virtual void DoScreenToClient( int *x, int *y ) const;
|
|
virtual void DoGetPosition( int *x, int *y ) const;
|
|
virtual void DoGetSize( int *width, int *height ) const;
|
|
virtual void DoGetClientSize( int *width, int *height ) const;
|
|
virtual void DoSetSize(int x, int y,
|
|
int width, int height,
|
|
int sizeFlags = wxSIZE_AUTO);
|
|
virtual void DoSetClientSize(int width, int height);
|
|
virtual void DoMoveWindow(int x, int y, int width, int height);
|
|
virtual bool DoPopupMenu(wxMenu *menu, int x, int y);
|
|
|
|
#if wxUSE_TOOLTIPS
|
|
virtual void DoSetToolTip( wxToolTip *tip );
|
|
#endif // wxUSE_TOOLTIPS
|
|
|
|
private:
|
|
// common part of all ctors
|
|
void Init();
|
|
|
|
DECLARE_DYNAMIC_CLASS(wxWindow)
|
|
DECLARE_NO_COPY_CLASS(wxWindow)
|
|
DECLARE_EVENT_TABLE()
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// A little class to switch off `size optimization' while an instance of the
|
|
// object exists: this may be useful to temporarily disable the optimisation
|
|
// which consists to do nothing when the new size is equal to the old size -
|
|
// although quite useful usually to avoid flicker, sometimes it leads to
|
|
// undesired effects.
|
|
//
|
|
// Usage: create an instance of this class on the stack to disable the size
|
|
// optimisation, it will be reenabled as soon as the object goes out from scope.
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLEXPORT wxNoOptimize
|
|
{
|
|
public:
|
|
wxNoOptimize() { ms_count++; }
|
|
~wxNoOptimize() { ms_count--; }
|
|
|
|
static bool CanOptimize() { return ms_count == 0; }
|
|
|
|
protected:
|
|
static int ms_count;
|
|
};
|
|
|
|
#endif
|
|
// _WX_WINDOW_H_
|