- Main Page
- Namespaces
- Classes
- Files

# App_WithDoc.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_APP_WITHDOC_H
    00020 #define BAKERY_APP_WITHDOC_H
    00021
    00022 #include <bakery/App/App.h>
    00023 #include <bakery/Document/Document.h>
    00024
    00025 namespace Bakery
    00026 {
    00027
    00055 class App_WithDoc : virtual public App //virtual because App_WithDoc_Gtk will inherit it via App_With_Doc and via App_Gtk.
    00056 {
    00057 public:
    00059   App_WithDoc(const Glib::ustring& appname = ""); //TODO: appname when using get_derived_widget()
    00060
    00061   virtual ~App_WithDoc();
    00062
    00063   virtual void init(); //overridden to create document.
    00064
    00065   enum enumSaveChanges
    00066   {
    00067     SAVECHANGES_Save,
    00068     SAVECHANGES_Cancel,
    00069     SAVECHANGES_Discard
    00070   };
    00071
    00072   static bool file_exists(const Glib::ustring& uri);
    00073
    00074 protected:
    00075   virtual void init_create_document(); //override this to new() the specific document type.
    00076
    00081   static void add_mime_type(const Glib::ustring& mime_type);
    00082
    00084   virtual Document* get_document();
    00085
    00087   virtual const Document* get_document() const ;
    00088
    00089   virtual void set_document_modified(bool bModified = true);
    00090
    00095   virtual bool open_document(const Glib::ustring& file_uri);
    00096
    00097   //This cannot be virtual, because that would break our ABI.
    00098   //Hopefully that is not necessary.
    00105   bool open_document_from_data(const guchar* data, std::size_t length);
    00106
    00107   virtual void document_history_add(const Glib::ustring& file_uri);
    00108   virtual void document_history_remove(const Glib::ustring& file_uri);
    00109
    00110 public:
    00111   // We can not take function pointers of these methods in
    00112   // a derived class if they are protected - for instance, with sigc::mem_fun()
    00113   //Signal handlers:
    00114
    00115   //Menu items:
    00116   virtual void on_menu_file_open();
    00117   virtual void on_menu_file_saveas(); //signal handler.
    00118   virtual void offer_saveas(); //For direct use.
    00119   virtual void on_menu_file_save(); //signal handler.
    00120   virtual void on_menu_file_close();
    00121
    00122   virtual void on_menu_edit_copy();
    00123   virtual void on_menu_edit_paste();
    00124   virtual void on_menu_edit_clear();
    00125
    00126 protected:
    00127   //Document:
    00128
    00130   virtual void on_document_modified(bool modified);
    00131
    00133   virtual bool on_document_load();
    00134
    00135   virtual void offer_to_save_changes();
    00136
    00138   virtual void cancel_close_or_exit();
    00139
    00141   virtual void close_mark_or_destroy();
    00142
    00143   virtual void update_window_title();
    00144
    00145   virtual void after_successful_save(); //e.g. disable File|Save.
    00146
    00147   virtual void ui_warning(const Glib::ustring& text, const Glib::ustring& secondary_text) = 0;
    00148   virtual Glib::ustring ui_file_select_open(const Glib::ustring& ui_file_select_open = Glib::ustring()) = 0;
    00149
    00154   virtual Glib::ustring ui_file_select_save(const Glib::ustring& old_file_uri) = 0;
    00155
    00156   virtual void ui_show_modification_status() = 0;
    00157
    00158   virtual enumSaveChanges ui_offer_to_save_changes() = 0;
    00159
    00160   static Glib::ustring get_conf_fullkey(const Glib::ustring& key);
    00161
    00162   //Document:
    00163   Document* m_pDocument; //An instance of a derived type.
    00164   bool m_bCloseAfterSave;
    00165
    00166   //Mime types which this application can load and save:
    00167   typedef std::list<Glib::ustring> type_list_strings;
    00168   static type_list_strings m_mime_types;
    00169 };
    00170
    00171 } //namespace
    00172
    00173 #endif //BAKERY_APP_WITHDOC_H