little doc updates

[wxWidgets.git] / include / wx / gtk1 / frame.h

diff --git a/include/wx/gtk1/frame.h b/include/wx/gtk1/frame.h
index 76e0a5c5b155cc8a58033677fe0c076de36cb7f6..6dda00580119a965672c94caacbdc05a72dfdb85 100644 (file)
--- a/include/wx/gtk1/frame.h
+++ b/include/wx/gtk1/frame.h
@@ -2,9 +2,8 @@
 // Name:        frame.h
 // Purpose:
 // Author:      Robert Roebling
-// Created:     01/02/97
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
+// Id:          $Id$
+// Copyright:   (c) 1998 Robert Roebling, Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
@@ -19,6 +18,7 @@
 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/window.h"
+#include "wx/icon.h"
 
 //-----------------------------------------------------------------------------
 // classes
@@ -37,8 +37,8 @@ class wxFrame;
 // global data
 //-----------------------------------------------------------------------------
 
-extern const char *wxFrameNameStr;
-extern const char *wxToolBarNameStr;
+extern const wxChar *wxFrameNameStr;
+extern const wxChar *wxToolBarNameStr;
 
 //-----------------------------------------------------------------------------
 // wxFrame
@@ -46,73 +46,86 @@ extern const char *wxToolBarNameStr;
 
 class wxFrame: public wxWindow
 {
-  DECLARE_DYNAMIC_CLASS(wxFrame)
-public:
+DECLARE_DYNAMIC_CLASS(wxFrame)
 
-  wxFrame();
-  wxFrame( wxWindow *parent, wxWindowID id, const wxString &title,
-    const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
-    long style = wxDEFAULT_FRAME_STYLE, const wxString &name = wxFrameNameStr );
-  bool Create( wxWindow *parent, wxWindowID id, const wxString &title,
-    const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
-    long style = wxDEFAULT_FRAME_STYLE, const wxString &name = wxFrameNameStr );
-  ~wxFrame();
-  bool Destroy();
-
-  virtual bool Show( bool show );
-  virtual void Enable( bool enable );
-
-  virtual void GetClientSize( int *width, int *height ) const;
-  virtual void SetClientSize( int const width, int const height );
-  
-    // set minimal/maxmimal size for the frame
-  virtual void SetSizeHints( int minW, int minH, int maxW, int maxH, int incW = -1 );
-
-  virtual wxStatusBar* CreateStatusBar(int number=1, long style = wxST_SIZEGRIP, wxWindowID id = 0,
-    const wxString& name = "statusBar");
-  virtual wxStatusBar *GetStatusBar();
-  virtual void SetStatusText( const wxString &text, int number = 0 );
-  virtual void SetStatusWidths( int n, int *width );
-
-  virtual wxToolBar* CreateToolBar( long style = wxNO_BORDER|wxTB_HORIZONTAL, wxWindowID id = -1, 
-                                    const wxString& name = wxToolBarNameStr);
-  virtual wxToolBar *GetToolBar();
-  
-  virtual void SetMenuBar( wxMenuBar *menuBar );
-  virtual wxMenuBar *GetMenuBar();
-
-  virtual void SetTitle( const wxString &title );
-  virtual wxString GetTitle() const { return m_title; }
-  
-  virtual void SetIcon( const wxIcon &icon );
-
-  void OnActivate( wxActivateEvent &WXUNUSED(event) ) { } // called from docview.cpp
-  void OnSize( wxSizeEvent &event );
-  void OnCloseWindow( wxCloseEvent& event );
-  void OnIdle(wxIdleEvent& event);
-
-  virtual void AddChild( wxWindow *child );
-  virtual void GtkOnSize( int x, int y, int width, int height );
+public:
+    wxFrame();
+    wxFrame( wxWindow *parent, wxWindowID id, const wxString &title,
+            const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
+            long style = wxDEFAULT_FRAME_STYLE, const wxString &name = wxFrameNameStr );
+    bool Create( wxWindow *parent, wxWindowID id, const wxString &title,
+            const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
+            long style = wxDEFAULT_FRAME_STYLE, const wxString &name = wxFrameNameStr );
+    ~wxFrame();
+    bool Destroy();
+
+    virtual bool Show( bool show );
+    virtual void Centre( int direction = wxHORIZONTAL );
+
+    virtual void GetClientSize( int *width, int *height ) const;
+
+    virtual wxStatusBar* CreateStatusBar(int number=1, long style = wxST_SIZEGRIP, wxWindowID id = 0,
+            const wxString& name = _T("statusBar"));
+    virtual wxStatusBar *OnCreateStatusBar( int number, long style, wxWindowID id,
+            const wxString& name );
+    virtual wxStatusBar *GetStatusBar() const;
+    inline void SetStatusBar(wxStatusBar *statusBar) { m_frameStatusBar = statusBar; }
+    virtual void SetStatusText( const wxString &text, int number = 0 );
+    virtual void SetStatusWidths( int n, const int widths_field[] );
+
+    virtual wxToolBar* CreateToolBar( long style = wxNO_BORDER|wxTB_HORIZONTAL, wxWindowID id = -1,
+            const wxString& name = wxToolBarNameStr);
+    virtual wxToolBar *OnCreateToolBar( long style, wxWindowID id, const wxString& name );
+    virtual wxToolBar *GetToolBar() const;
+    inline void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
+
+    virtual void SetMenuBar( wxMenuBar *menuBar );
+    virtual wxMenuBar *GetMenuBar() const;
+
+    virtual void SetTitle( const wxString &title );
+    virtual wxString GetTitle() const { return m_title; }
+
+    virtual void SetIcon( const wxIcon &icon );
+    virtual void Iconize( bool WXUNUSED(iconize)) { }
+    virtual bool IsIconized() const { return FALSE; }
+    bool Iconized() const { return IsIconized(); }
+    virtual void Maximize(bool WXUNUSED(maximize)) {}
+    virtual void Restore() {}
+
+    virtual void Command( int id );
+    
+    void OnCloseWindow( wxCloseEvent& event );
+    void OnActivate( wxActivateEvent &WXUNUSED(event) ) { } // called from docview.cpp
+    void OnSize( wxSizeEvent &event );
+
+    void OnMenuHighlight( wxMenuEvent& event );
+
+    // implementation
+
+    virtual void GtkOnSize( int x, int y, int width, int height );
+    void DoMenuUpdates();
+    void DoMenuUpdates(wxMenu* menu, wxWindow* focusWin);
+    virtual void OnInternalIdle();
+
+    wxMenuBar    *m_frameMenuBar;
+    wxStatusBar  *m_frameStatusBar;
+    wxToolBar    *m_frameToolBar;
+    wxString      m_title;
+    wxIcon        m_icon;
+    int           m_miniEdge,m_miniTitle;
+    GtkWidget    *m_mainWidget;
+    bool          m_menuBarDetached;
+    bool          m_toolBarDetached;
+
+protected:
+    virtual void DoSetSize(int x, int y,
+                           int width, int height,
+                           int sizeFlags = wxSIZE_AUTO);
+
+    virtual void DoSetClientSize(int width, int height);
 
 private:
-  friend  wxWindow;
-  friend  wxMDIChildFrame;
-  friend  wxMDIClientWindow;
-
-  // update frame's menus (called from OnIdle)
-  void DoMenuUpdates();
-  void DoMenuUpdates(wxMenu* menu);
-
-  GtkWidget    *m_mainWindow;
-  wxMenuBar    *m_frameMenuBar;
-  wxStatusBar  *m_frameStatusBar;
-  wxToolBar    *m_frameToolBar;
-  int           m_toolBarHeight;
-  bool          m_addPrivateChild;   // for toolbar (and maybe menubar)
-  wxString      m_title;
-  wxIcon        m_icon;
-
-  DECLARE_EVENT_TABLE()
+    DECLARE_EVENT_TABLE()
 };
 
 #endif // __GTKFRAMEH__