Tidied/commented FL header files, regenerated docs and filled out Category section.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@13738 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

contrib/include/wx/fl/frmview.h

@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        No names yet.
-// Purpose:     Contrib. demo
+// Name:        frmview.h
+// Purpose:     wxFrameView and wxFrameManager classes.
 // Author:      Aleksandras Gluchovas
 // Modified by:
 // Created:     02/01/99
 // RCS-ID:      $Id$
 // Copyright:   (c) Aleksandras Gluchovas
-// Licence:   	wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __FRMVIEW_G__
@@ -28,112 +28,120 @@ class wxObjectStorage;
 
 class wxFrameManager;
 
+/*
+It is not clear what this class does. It is not used elsewhere in FL.
+*/
+
 class wxFrameView : public wxEvtHandler
 {
 protected:
-	wxStringList    mTopMenus;
-	wxFrameLayout*  mpLayout;
-	wxFrameManager* mpFrameMgr;
-	bool            mDoToolUpdates;
+    wxStringList    mTopMenus;
+    wxFrameLayout*  mpLayout;
+    wxFrameManager* mpFrameMgr;
+    bool            mDoToolUpdates;
 
-	friend class wxFrameManager;
-	friend class wxFrameViewSerializer;	
+    friend class wxFrameManager;
+    friend class wxFrameViewSerializer;
 
 protected:
-	void OnIdle( wxIdleEvent& event);
-	
+    void OnIdle( wxIdleEvent& event);
+
 public:
-	wxFrameView();
-	~wxFrameView();
+    wxFrameView();
+    ~wxFrameView();
 
-	virtual void Activate();
-	virtual void Deactivate();
+    virtual void Activate();
+    virtual void Deactivate();
 
-	wxFrame* GetParentFrame();
-	wxWindow* GetClientWindow();
+    wxFrame* GetParentFrame();
+    wxWindow* GetClientWindow();
 
-	wxFrameManager& GetFrameManager();
+    wxFrameManager& GetFrameManager();
 
-	void RegisterMenu( const wxString& topMenuName );
+    void RegisterMenu( const wxString& topMenuName );
 
-	void CreateLayout();
-	wxFrameLayout* GetLayout();
-	void SetLayout( wxFrameLayout* pLayout );
-	void SetToolUpdates( bool doToolUpdates = TRUE );
+    void CreateLayout();
+    wxFrameLayout* GetLayout();
+    void SetLayout( wxFrameLayout* pLayout );
+    void SetToolUpdates( bool doToolUpdates = TRUE );
 
 
-	// hooks for specific frame-views
+    // hooks for specific frame-views
 
-	virtual void OnInit() {}
+    virtual void OnInit() {}
 
-	virtual void OnSerialize( wxObjectStorage& store ) {}
-	virtual void OnActiveate() {}
-	virtual void OnDeactivate() {}
+    virtual void OnSerialize( wxObjectStorage& store ) {}
+    virtual void OnActiveate() {}
+    virtual void OnDeactivate() {}
 
-	// imp. is mandatory
-	virtual void OnRecreate() {}
-	virtual void OnInitMenus() {}
+    // imp. is mandatory
+    virtual void OnRecreate() {}
+    virtual void OnInitMenus() {}
 
-	DECLARE_EVENT_TABLE()
+    DECLARE_EVENT_TABLE()
 };
 
 class wxFrame;
 
+/*
+It is not clear what this class does. It is not used elsewhere in FL.
+*/
+
 class wxFrameManager : wxObject
 {
 protected:
-	wxList       mViews;
-	wxWindow*    mpFrameWnd;
-	int          mActiveViewNo;
-	wxWindow*    mpClientWnd;
+    wxList       mViews;
+    wxWindow*    mpFrameWnd;
+    int          mActiveViewNo;
+    wxWindow*    mpClientWnd;
 
 #if 0
-	wxObjectStorage mStore;
+    wxObjectStorage mStore;
 #endif
 
-	wxString        mSettingsFile;
+    wxString        mSettingsFile;
 
 protected:
-	void DoSerialize( wxObjectStorage& store );
-	void DestroyViews();
-	int GetViewNo( wxFrameView* pView );
-	void EnableMenusForView( wxFrameView* pView, bool enable );
-	void SyncAllMenus();
+    void DoSerialize( wxObjectStorage& store );
+    void DestroyViews();
+    int GetViewNo( wxFrameView* pView );
+    void EnableMenusForView( wxFrameView* pView, bool enable );
+    void SyncAllMenus();
 
 public:
-	wxFrameManager();
-	~wxFrameManager();
+    wxFrameManager();
+    ~wxFrameManager();
 
-	// if file name is empty, views are are not saved/loaded
+    // if file name is empty, views are are not saved/loaded
 
-	virtual void Init( wxWindow* pMainFrame, const wxString& settingsFile = "" );
+    virtual void Init( wxWindow* pMainFrame, const wxString& settingsFile = "" );
 
-	// synonyms
-	wxFrame* GetParentFrame();
-	wxWindow* GetParentWindow();
+    // synonyms
+    wxFrame* GetParentFrame();
+    wxWindow* GetParentWindow();
 
-	int GetActiveViewNo();
-	wxFrameView* GetActiveView();
-	wxNode* GetActiveViewNode();
+    int GetActiveViewNo();
+    wxFrameView* GetActiveView();
+    wxNode* GetActiveViewNode();
 
-	wxFrameView* GetView( int viewNo );
+    wxFrameView* GetView( int viewNo );
 
-	void SetClinetWindow( wxWindow* pFrameClient ); 
-	wxWindow* GetClientWindow();
+    void SetClinetWindow( wxWindow* pFrameClient ); 
+    wxWindow* GetClientWindow();
 
-	void AddView( wxFrameView* pFrmView );
-	void RemoveView( wxFrameView* pFrmView );
+    void AddView( wxFrameView* pFrmView );
+    void RemoveView( wxFrameView* pFrmView );
 
-	void ActivateView( int viewNo );
-	void ActivateView( wxFrameView* pFrmView );
-	void DeactivateCurrentView();
+    void ActivateView( int viewNo );
+    void ActivateView( wxFrameView* pFrmView );
+    void DeactivateCurrentView();
 
-	wxObjectStorage& GetObjectStore();
+    wxObjectStorage& GetObjectStore();
 
-	void SaveViewsNow();
-	bool ReloadViews();
+    void SaveViewsNow();
+    bool ReloadViews();
 
-	bool ViewsAreLoaded();
+    bool ViewsAreLoaded();
 };
 
 #endif /* __FRMVIEW_G__ */