include/wx/univ/toplevel.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/toplevel.h
   3 // Purpose:     Top level window, abstraction of wxFrame and wxDialog
   4 // Author:      Vaclav Slavik
   5 // Id:          $Id$
   6 // Copyright:   (c) 2001-2002 SciTech Software, Inc. (www.scitechsoft.com)
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10
  11 #ifndef __WX_UNIV_TOPLEVEL_H__
  12 #define __WX_UNIV_TOPLEVEL_H__
  13
  14 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  15     #pragma interface "univtoplevel.h"
  16 #endif
  17
  18 #include "wx/univ/inpcons.h"
  19 #include "wx/univ/inphand.h"
  20 #include "wx/icon.h"
  21
  22 // ----------------------------------------------------------------------------
  23 // constants
  24 // ----------------------------------------------------------------------------
  25
  26 // frame decorations type flags used in wxRenderer and wxColourScheme
  27 enum
  28 {
  29     wxTOPLEVEL_ACTIVE          = 0x00000001,
  30     wxTOPLEVEL_MAXIMIZED       = 0x00000002,
  31     wxTOPLEVEL_TITLEBAR        = 0x00000004,
  32     wxTOPLEVEL_ICON            = 0x00000008,
  33     wxTOPLEVEL_RESIZEABLE      = 0x00000010,
  34     wxTOPLEVEL_BORDER          = 0x00000020,
  35     wxTOPLEVEL_BUTTON_CLOSE    = 0x01000000,
  36     wxTOPLEVEL_BUTTON_MAXIMIZE = 0x02000000,
  37     wxTOPLEVEL_BUTTON_ICONIZE =  0x04000000,
  38     wxTOPLEVEL_BUTTON_RESTORE  = 0x08000000,
  39     wxTOPLEVEL_BUTTON_HELP     = 0x10000000
  40 };
  41
  42 // frame hit test return values:
  43 enum
  44 {
  45     wxHT_TOPLEVEL_NOWHERE         = 0x00000000,
  46     wxHT_TOPLEVEL_CLIENT_AREA     = 0x00000001,
  47     wxHT_TOPLEVEL_ICON            = 0x00000002,
  48     wxHT_TOPLEVEL_TITLEBAR        = 0x00000004,
  49
  50     wxHT_TOPLEVEL_BORDER_N        = 0x00000010,
  51     wxHT_TOPLEVEL_BORDER_S        = 0x00000020,
  52     wxHT_TOPLEVEL_BORDER_E        = 0x00000040,
  53     wxHT_TOPLEVEL_BORDER_W        = 0x00000080,
  54     wxHT_TOPLEVEL_BORDER_NE       = wxHT_TOPLEVEL_BORDER_N | wxHT_TOPLEVEL_BORDER_E,
  55     wxHT_TOPLEVEL_BORDER_SE       = wxHT_TOPLEVEL_BORDER_S | wxHT_TOPLEVEL_BORDER_E,
  56     wxHT_TOPLEVEL_BORDER_NW       = wxHT_TOPLEVEL_BORDER_N | wxHT_TOPLEVEL_BORDER_W,
  57     wxHT_TOPLEVEL_BORDER_SW       = wxHT_TOPLEVEL_BORDER_S | wxHT_TOPLEVEL_BORDER_W,
  58     wxHT_TOPLEVEL_ANY_BORDER      = 0x000000F0,
  59
  60     wxHT_TOPLEVEL_BUTTON_CLOSE    = /*0x01000000*/ wxTOPLEVEL_BUTTON_CLOSE,
  61     wxHT_TOPLEVEL_BUTTON_MAXIMIZE = /*0x02000000*/ wxTOPLEVEL_BUTTON_MAXIMIZE,
  62     wxHT_TOPLEVEL_BUTTON_ICONIZE =  /*0x04000000*/ wxTOPLEVEL_BUTTON_ICONIZE,
  63     wxHT_TOPLEVEL_BUTTON_RESTORE  = /*0x08000000*/ wxTOPLEVEL_BUTTON_RESTORE,
  64     wxHT_TOPLEVEL_BUTTON_HELP     = /*0x10000000*/ wxTOPLEVEL_BUTTON_HELP,
  65     wxHT_TOPLEVEL_ANY_BUTTON      =   0x1F000000
  66 };
  67
  68 // Flags for interactive frame manipulation functions (only in wxUniversal):
  69 enum
  70 {
  71     wxINTERACTIVE_MOVE           = 0x00000001,
  72     wxINTERACTIVE_RESIZE         = 0x00000002,
  73     wxINTERACTIVE_RESIZE_S       = 0x00000010,
  74     wxINTERACTIVE_RESIZE_N       = 0x00000020,
  75     wxINTERACTIVE_RESIZE_W       = 0x00000040,
  76     wxINTERACTIVE_RESIZE_E       = 0x00000080,
  77     wxINTERACTIVE_WAIT_FOR_INPUT = 0x10000000
  78 };
  79
  80 // ----------------------------------------------------------------------------
  81 // the actions supported by this control
  82 // ----------------------------------------------------------------------------
  83
  84 #define wxACTION_TOPLEVEL_ACTIVATE       _T("activate")   // (de)activate the frame
  85 #define wxACTION_TOPLEVEL_BUTTON_PRESS   _T("pressbtn")   // press titlebar btn
  86 #define wxACTION_TOPLEVEL_BUTTON_RELEASE _T("releasebtn") // press titlebar btn
  87 #define wxACTION_TOPLEVEL_BUTTON_CLICK   _T("clickbtn")   // press titlebar btn
  88 #define wxACTION_TOPLEVEL_MOVE           _T("move")       // move the frame
  89 #define wxACTION_TOPLEVEL_RESIZE         _T("resize")     // resize the frame
  90
  91 //-----------------------------------------------------------------------------
  92 // wxTopLevelWindow
  93 //-----------------------------------------------------------------------------
  94
  95 class WXDLLEXPORT wxTopLevelWindow : public wxTopLevelWindowNative,
  96                                      public wxInputConsumer
  97 {
  98 public:
  99     // construction
 100     wxTopLevelWindow();
 101     wxTopLevelWindow(wxWindow *parent,
 102                      wxWindowID id,
 103                      const wxString& title,
 104                      const wxPoint& pos = wxDefaultPosition,
 105                      const wxSize& size = wxDefaultSize,
 106                      long style = wxDEFAULT_FRAME_STYLE,
 107                      const wxString& name = wxFrameNameStr);
 108
 109     bool Create(wxWindow *parent,
 110                 wxWindowID id,
 111                 const wxString& title,
 112                 const wxPoint& pos = wxDefaultPosition,
 113                 const wxSize& size = wxDefaultSize,
 114                 long style = wxDEFAULT_FRAME_STYLE,
 115                 const wxString& name = wxFrameNameStr);
 116
 117     // implement base class pure virtuals
 118     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
 119     virtual wxPoint GetClientAreaOrigin() const;
 120     virtual void DoGetClientSize(int *width, int *height) const;
 121     virtual void DoSetClientSize(int width, int height);
 122     virtual void SetIcon(const wxIcon& icon) { SetIcons( wxIconBundle( icon ) ); }
 123     virtual void SetIcons(const wxIconBundle& icons);
 124
 125     // implementation from now on
 126     // --------------------------
 127
 128     // tests for frame's part at given point
 129     long HitTest(const wxPoint& pt) const;
 130
 131     virtual bool PerformAction(const wxControlAction& action,
 132                                long numArg = -1,
 133                                const wxString& strArg = wxEmptyString);
 134
 135     // move/resize the frame interactively, i.e. let the user do it
 136     virtual void InteractiveMove(int flags = wxINTERACTIVE_MOVE);
 137
 138     virtual int GetMinWidth() const;
 139     virtual int GetMinHeight() const;
 140
 141     virtual bool ProvidesBackground() const { return TRUE; }
 142
 143 protected:
 144     // handle titlebar button click event
 145     virtual void ClickTitleBarButton(long button);
 146
 147     virtual wxWindow *GetInputWindow() const { return (wxWindow*)this; }
 148
 149     // return wxTOPLEVEL_xxx combination based on current state of the frame
 150     long GetDecorationsStyle() const;
 151
 152     // common part of all ctors
 153     void Init();
 154
 155     void RefreshTitleBar();
 156     void OnNcPaint(wxPaintEvent& event);
 157     void OnSystemMenu(wxCommandEvent& event);
 158
 159     // TRUE if wxTLW should render decorations (aka titlebar) itself
 160     static int ms_drawDecorations;
 161     // TRUE if wxTLW can be iconized
 162     static int ms_canIconize;
 163     // true for currently active frame
 164     bool m_isActive:1;
 165     // version of icon for titlebar (16x16)
 166     wxIcon m_titlebarIcon;
 167     // saved window style in fullscreen mdoe
 168     long m_fsSavedStyle;
 169     // currently pressed titlebar button
 170     long m_pressedButton;
 171
 172     DECLARE_DYNAMIC_CLASS(wxTopLevelWindow)
 173     DECLARE_EVENT_TABLE()
 174     WX_DECLARE_INPUT_CONSUMER()
 175 };
 176
 177 // ----------------------------------------------------------------------------
 178 // wxStdFrameInputHandler: handles focus, resizing and titlebar buttons clicks
 179 // ----------------------------------------------------------------------------
 180
 181 class WXDLLEXPORT wxStdFrameInputHandler : public wxStdInputHandler
 182 {
 183 public:
 184     wxStdFrameInputHandler(wxInputHandler *inphand);
 185
 186     virtual bool HandleMouse(wxInputConsumer *consumer,
 187                              const wxMouseEvent& event);
 188     virtual bool HandleMouseMove(wxInputConsumer *consumer, const wxMouseEvent& event);
 189     virtual bool HandleActivation(wxInputConsumer *consumer, bool activated);
 190
 191 private:
 192     // the window (button) which has capture or NULL and the last hittest result
 193     wxTopLevelWindow *m_winCapture;
 194     long              m_winHitTest;
 195     long              m_winPressed;
 196     bool              m_borderCursorOn;
 197     wxCursor          m_origCursor;
 198 };
 199
 200 #endif // __WX_UNIV_TOPLEVEL_H__