Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

Document.h

Go to the documentation of this file.
00001 /*
00002  * Copyright 2000 Murray Cumming
00003  *
00004  * This library is free software; you can redistribute it and/or
00005  * modify it under the terms of the GNU Library General Public
00006  * License as published by the Free Software Foundation; either
00007  * version 2 of the License, or (at your option) any later version.
00008  *
00009  * This library is distributed in the hope that it will be useful,
00010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012  * Library General Public License for more details.
00013  *
00014  * You should have received a copy of the GNU Library General Public
00015  * License along with this library; if not, write to the Free
00016  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00017  */
00018 
00019 #ifndef BAKERY_DOCUMENT_H
00020 #define BAKERY_DOCUMENT_H
00021 
00022 #include "bakery/View/View.h"
00023 #include <glibmm.h>
00024 
00025 #include <iostream>
00026 
00027 namespace Bakery
00028 {
00029 
00034 class Document
00035 {
00036 public: 
00037   Document();
00038   virtual ~Document();
00039 
00040   /* Saves the data to disk.
00041    * Asks the View to update this document before saving to disk,
00042    * but you should probably ensure that the document is updated more regularly than this,
00043    * so that different parts of the GUI are synchronized.
00044    * Only saves if the document has been modified.
00045    * bool indicates success.
00046    */
00047   virtual bool save();
00048 
00049   /* Loads data from disk, then asks the View to update itself.
00050    * bool indicates success.
00051    */
00052   virtual bool load();
00053 
00054   virtual bool get_modified() const;
00055   virtual void set_modified(bool bVal = true);
00056 
00058   virtual bool get_is_new() const;
00060   void set_is_new(bool bVal);
00061 
00062   virtual Glib::ustring get_contents() const;
00063   virtual void set_contents(const Glib::ustring& strVal);
00064 
00065   virtual Glib::ustring get_filepath() const;
00066   virtual void set_filepath(const Glib::ustring& strVal, bool bEnforceFileExtension = false);
00067 
00069   virtual Glib::ustring get_name() const;
00070   static Glib::ustring util_filepath_get_name(const Glib::ustring& filePath);
00071 
00072   virtual bool get_read_only() const;
00073   virtual void set_read_only(bool bVal);
00074   
00076   virtual void set_view(ViewBase* pView);
00077   virtual ViewBase* get_view();
00078 
00079   virtual void set_file_extension(const Glib::ustring& strVal);
00080   virtual Glib::ustring get_file_extension() const;
00081 
00082   //Signals
00083   typedef SigC::Signal0<void> type_signal_modified;
00084   type_signal_modified& signal_modified();
00085 
00087 
00088 protected:
00092   virtual bool load_after();
00093 
00097   virtual bool save_before();
00098 
00099   virtual bool read_from_disk();
00100   virtual bool write_to_disk();
00101 
00102   Glib::ustring m_strContents;
00103   Glib::ustring m_strFilePath;
00104   Glib::ustring m_strFileExtension;
00105 
00106   ViewBase* m_pView;
00107 
00108   type_signal_modified signal_modified_;
00109 
00110   bool m_bModified;
00111   bool m_bIsNew; //see get_is_new().
00112   bool m_bReadOnly;
00113 };
00114 
00115 } //namespace
00116 
00117 #endif //GNOME_APPWITHDOCS_DOCUMENT_H

Generated on Tue Dec 14 18:54:16 2004 for bakery by  doxygen 1.3.9.1