include/wx/generic/mdig.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/generic/mdig.h
   3 // Purpose:     Generic MDI (Multiple Document Interface) classes
   4 // Author:      Hans Van Leemputten
   5 // Modified by:
   6 // Created:     29/07/2002
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Hans Van Leemputten
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MDIG_H_
  13 #define _WX_MDIG_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/frame.h"
  20 #include "wx/panel.h"
  21 #include "wx/notebook.h"
  22
  23 extern WXDLLEXPORT_DATA(const wxChar) wxStatusLineNameStr[];
  24
  25
  26 //-----------------------------------------------------------------------------
  27 // classes
  28 //-----------------------------------------------------------------------------
  29
  30 class WXDLLEXPORT wxGenericMDIParentFrame;
  31 class WXDLLEXPORT wxGenericMDIClientWindow;
  32 class WXDLLEXPORT wxGenericMDIChildFrame;
  33
  34 //-----------------------------------------------------------------------------
  35 // wxGenericMDIParentFrame
  36 //-----------------------------------------------------------------------------
  37
  38 class WXDLLEXPORT wxGenericMDIParentFrame: public wxFrame
  39 {
  40 public:
  41     wxGenericMDIParentFrame();
  42     wxGenericMDIParentFrame(wxWindow *parent,
  43                      wxWindowID winid,
  44                      const wxString& title,
  45                      const wxPoint& pos = wxDefaultPosition,
  46                      const wxSize& size = wxDefaultSize,
  47                      long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
  48                      const wxString& name = wxFrameNameStr);
  49
  50     virtual ~wxGenericMDIParentFrame();
  51     bool Create( wxWindow *parent,
  52                  wxWindowID winid,
  53                  const wxString& title,
  54                  const wxPoint& pos = wxDefaultPosition,
  55                  const wxSize& size = wxDefaultSize,
  56                  long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
  57                  const wxString& name = wxFrameNameStr );
  58
  59 #if wxUSE_MENUS
  60     wxMenu* GetWindowMenu() const { return m_pWindowMenu; };
  61     void SetWindowMenu(wxMenu* pMenu);
  62
  63     virtual void SetMenuBar(wxMenuBar *pMenuBar);
  64 #endif // wxUSE_MENUS
  65
  66     void SetChildMenuBar(wxGenericMDIChildFrame *pChild);
  67
  68     virtual bool ProcessEvent(wxEvent& event);
  69
  70     wxGenericMDIChildFrame *GetActiveChild() const;
  71     inline void SetActiveChild(wxGenericMDIChildFrame* pChildFrame);
  72
  73     wxGenericMDIClientWindow *GetClientWindow() const;
  74     virtual wxGenericMDIClientWindow *OnCreateClient();
  75
  76     virtual void Cascade() { /* Has no effect */ }
  77     virtual void Tile(wxOrientation WXUNUSED(orient) = wxHORIZONTAL) { }
  78     virtual void ArrangeIcons() { /* Has no effect */ }
  79     virtual void ActivateNext();
  80     virtual void ActivatePrevious();
  81
  82 protected:
  83     wxGenericMDIClientWindow   *m_pClientWindow;
  84     wxGenericMDIChildFrame     *m_pActiveChild;
  85 #if wxUSE_MENUS
  86     wxMenu              *m_pWindowMenu;
  87     wxMenuBar           *m_pMyMenuBar;
  88 #endif // wxUSE_MENUS
  89
  90 protected:
  91     void Init();
  92
  93 #if wxUSE_MENUS
  94     void RemoveWindowMenu(wxMenuBar *pMenuBar);
  95     void AddWindowMenu(wxMenuBar *pMenuBar);
  96
  97     void DoHandleMenu(wxCommandEvent &event);
  98 #endif // wxUSE_MENUS
  99
 100     virtual void DoGetClientSize(int *width, int *height) const;
 101
 102 private:
 103     DECLARE_EVENT_TABLE()
 104     DECLARE_DYNAMIC_CLASS(wxGenericMDIParentFrame)
 105 };
 106
 107 //-----------------------------------------------------------------------------
 108 // wxGenericMDIChildFrame
 109 //-----------------------------------------------------------------------------
 110
 111 class WXDLLEXPORT wxGenericMDIChildFrame: public wxPanel
 112 {
 113 public:
 114     wxGenericMDIChildFrame();
 115     wxGenericMDIChildFrame( wxGenericMDIParentFrame *parent,
 116                      wxWindowID winid,
 117                      const wxString& title,
 118                      const wxPoint& pos = wxDefaultPosition,
 119                      const wxSize& size = wxDefaultSize,
 120                      long style = wxDEFAULT_FRAME_STYLE,
 121                      const wxString& name = wxFrameNameStr );
 122
 123     virtual ~wxGenericMDIChildFrame();
 124     bool Create( wxGenericMDIParentFrame *parent,
 125                  wxWindowID winid,
 126                  const wxString& title,
 127                  const wxPoint& pos = wxDefaultPosition,
 128                  const wxSize& size = wxDefaultSize,
 129                  long style = wxDEFAULT_FRAME_STYLE,
 130                  const wxString& name = wxFrameNameStr );
 131
 132 #if wxUSE_MENUS
 133     virtual void SetMenuBar( wxMenuBar *menu_bar );
 134     virtual wxMenuBar *GetMenuBar() const;
 135 #endif // wxUSE_MENUS
 136
 137     virtual void SetTitle(const wxString& title);
 138     virtual wxString GetTitle() const;
 139
 140     virtual void Activate();
 141
 142 #if wxUSE_STATUSBAR
 143     // no status bars
 144     virtual wxStatusBar* CreateStatusBar( int WXUNUSED(number) = 1,
 145                                         long WXUNUSED(style) = 1,
 146                                         wxWindowID WXUNUSED(winid) = 1,
 147                                         const wxString& WXUNUSED(name) = wxEmptyString)
 148       { return (wxStatusBar*)NULL; }
 149
 150     virtual wxStatusBar *GetStatusBar() const { return (wxStatusBar*)NULL; }
 151     virtual void SetStatusText( const wxString &WXUNUSED(text), int WXUNUSED(number)=0 ) {}
 152     virtual void SetStatusWidths( int WXUNUSED(n), const int WXUNUSED(widths_field)[] ) {}
 153 #endif
 154
 155     // no size hints
 156     virtual void DoSetSizeHints( int WXUNUSED(minW),
 157                                int WXUNUSED(minH),
 158                                int WXUNUSED(maxW) = wxDefaultCoord,
 159                                int WXUNUSED(maxH) = wxDefaultCoord,
 160                                int WXUNUSED(incW) = wxDefaultCoord,
 161                                int WXUNUSED(incH) = wxDefaultCoord) {}
 162
 163 #if wxUSE_TOOLBAR
 164     // no toolbar bars
 165     virtual wxToolBar* CreateToolBar( long WXUNUSED(style),
 166                                        wxWindowID WXUNUSED(winid),
 167                                        const wxString& WXUNUSED(name) )
 168         { return (wxToolBar*)NULL; }
 169     virtual wxToolBar *GetToolBar() const { return (wxToolBar*)NULL; }
 170 #endif
 171
 172     // no icon
 173     virtual void SetIcons( const wxIconBundle& WXUNUSED(icons) ) { }
 174
 175     // no maximize etc
 176     virtual void Maximize( bool WXUNUSED(maximize) = true) { /* Has no effect */ }
 177     virtual void Restore() { /* Has no effect */ }
 178     virtual void Iconize(bool WXUNUSED(iconize)  = true) { /* Has no effect */ }
 179     virtual bool IsMaximized() const { return true; }
 180     virtual bool IsIconized() const { return false; }
 181     virtual bool ShowFullScreen(bool WXUNUSED(show), long WXUNUSED(style)) { return false; }
 182     virtual bool IsFullScreen() const { return false; }
 183
 184     virtual bool IsTopLevel() const { return false; }
 185
 186     void OnMenuHighlight(wxMenuEvent& event);
 187     void OnActivate(wxActivateEvent& event);
 188
 189     // The next 2 are copied from top level...
 190     void OnCloseWindow(wxCloseEvent& event);
 191     void OnSize(wxSizeEvent& event);
 192
 193     void SetMDIParentFrame(wxGenericMDIParentFrame* parentFrame);
 194     wxGenericMDIParentFrame* GetMDIParentFrame() const;
 195
 196 protected:
 197     wxGenericMDIParentFrame *m_pMDIParentFrame;
 198     wxRect            m_MDIRect;
 199     wxString          m_Title;
 200
 201 #if wxUSE_MENUS
 202     wxMenuBar        *m_pMenuBar;
 203 #endif // wxUSE_MENUS
 204
 205 protected:
 206     void Init();
 207
 208     virtual void DoMoveWindow(int x, int y, int width, int height);
 209
 210     // This function needs to be called when a size change is confirmed,
 211     // we needed this function to prevent any body from the outside
 212     // changing the panel... it messes the UI layout when we would allow it.
 213     void ApplyMDIChildFrameRect();
 214
 215 private:
 216     DECLARE_DYNAMIC_CLASS(wxGenericMDIChildFrame)
 217     DECLARE_EVENT_TABLE()
 218
 219     friend class wxGenericMDIClientWindow;
 220 };
 221
 222 //-----------------------------------------------------------------------------
 223 // wxGenericMDIClientWindow
 224 //-----------------------------------------------------------------------------
 225
 226 class WXDLLEXPORT wxGenericMDIClientWindow: public wxNotebook
 227 {
 228 public:
 229     wxGenericMDIClientWindow();
 230     wxGenericMDIClientWindow( wxGenericMDIParentFrame *parent, long style = 0 );
 231     virtual ~wxGenericMDIClientWindow();
 232     virtual bool CreateClient( wxGenericMDIParentFrame *parent, long style = wxVSCROLL | wxHSCROLL );
 233
 234     virtual int SetSelection(size_t nPage);
 235
 236 protected:
 237     void PageChanged(int OldSelection, int newSelection);
 238
 239     void OnPageChanged(wxNotebookEvent& event);
 240     void OnSize(wxSizeEvent& event);
 241
 242 private:
 243     DECLARE_DYNAMIC_CLASS(wxGenericMDIClientWindow)
 244     DECLARE_EVENT_TABLE()
 245 };
 246
 247
 248 /*
 249  * Define normal wxMDI classes based on wxGenericMDI
 250  */
 251
 252 #ifndef wxUSE_GENERIC_MDI_AS_NATIVE
 253 #if defined(__WXUNIVERSAL__) || defined(__WXPM__) || defined(__WXCOCOA__)
 254 #define wxUSE_GENERIC_MDI_AS_NATIVE   1
 255 #else
 256 #define wxUSE_GENERIC_MDI_AS_NATIVE   0
 257 #endif
 258 #endif // wxUSE_GENERIC_MDI_AS_NATIVE
 259
 260 #if wxUSE_GENERIC_MDI_AS_NATIVE
 261
 262 class wxMDIChildFrame ;
 263
 264 //-----------------------------------------------------------------------------
 265 // wxMDIParentFrame
 266 //-----------------------------------------------------------------------------
 267
 268 class WXDLLEXPORT wxMDIParentFrame: public wxGenericMDIParentFrame
 269 {
 270 public:
 271     wxMDIParentFrame() {}
 272     wxMDIParentFrame(wxWindow *parent,
 273                      wxWindowID winid,
 274                      const wxString& title,
 275                      const wxPoint& pos = wxDefaultPosition,
 276                      const wxSize& size = wxDefaultSize,
 277                      long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
 278                      const wxString& name = wxFrameNameStr)
 279          :wxGenericMDIParentFrame(parent, winid, title, pos, size, style, name)
 280      {
 281      }
 282
 283     wxMDIChildFrame * GetActiveChild() const ;
 284
 285
 286 private:
 287     DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)
 288 };
 289
 290 //-----------------------------------------------------------------------------
 291 // wxMDIChildFrame
 292 //-----------------------------------------------------------------------------
 293
 294 class WXDLLEXPORT wxMDIChildFrame: public wxGenericMDIChildFrame
 295 {
 296 public:
 297     wxMDIChildFrame() {}
 298
 299     wxMDIChildFrame( wxGenericMDIParentFrame *parent,
 300                      wxWindowID winid,
 301                      const wxString& title,
 302                      const wxPoint& pos = wxDefaultPosition,
 303                      const wxSize& size = wxDefaultSize,
 304                      long style = wxDEFAULT_FRAME_STYLE,
 305                      const wxString& name = wxFrameNameStr )
 306          :wxGenericMDIChildFrame(parent, winid, title, pos, size, style, name)
 307      {
 308      }
 309 private:
 310     DECLARE_DYNAMIC_CLASS(wxMDIChildFrame)
 311 };
 312
 313 //-----------------------------------------------------------------------------
 314 // wxMDIClientWindow
 315 //-----------------------------------------------------------------------------
 316
 317 class WXDLLEXPORT wxMDIClientWindow: public wxGenericMDIClientWindow
 318 {
 319 public:
 320     wxMDIClientWindow() {}
 321
 322     wxMDIClientWindow( wxGenericMDIParentFrame *parent, long style = 0 )
 323         :wxGenericMDIClientWindow(parent, style)
 324     {
 325     }
 326
 327 private:
 328     DECLARE_DYNAMIC_CLASS(wxMDIClientWindow)
 329 };
 330
 331 #endif
 332
 333 #endif
 334     // _WX_MDIG_H_