bakery  2.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Bakery::App_WithDoc_Gtk Class Reference

This class implements Bakery::App_WithDoc using gtkmm. More...

#include <App_WithDoc_Gtk.h>

Inheritance diagram for Bakery::App_WithDoc_Gtk:
Inheritance graph
[legend]

Public Member Functions

 App_WithDoc_Gtk (const Glib::ustring &appname)
 Don't forget to call init() too. More...
 
 App_WithDoc_Gtk (BaseObjectType *cobject, const Glib::ustring &appname)
 This constructor can be used to implement derived classes for use with Gnome::Glade::Xml::get_derived_widget(). More...
 
virtual ~App_WithDoc_Gtk ()
 
virtual void init ()
 
- Public Member Functions inherited from Bakery::App_WithDoc
 App_WithDoc (const Glib::ustring &appname="")
 Don't forget to call init() too. More...
 
virtual ~App_WithDoc ()
 
virtual void on_menu_file_open ()
 
virtual void on_menu_file_saveas ()
 
virtual void offer_saveas ()
 
virtual void on_menu_file_save ()
 
virtual void on_menu_file_close ()
 
virtual void on_menu_edit_copy ()
 
virtual void on_menu_edit_paste ()
 
virtual void on_menu_edit_clear ()
 
- Public Member Functions inherited from Bakery::App
 App (const Glib::ustring &appname=Glib::ustring())
 Don't forget to call init() too. More...
 
virtual ~App ()
 
virtual Glib::ustring get_version () const
 
type_signal_hide ui_signal_hide ()
 
virtual void on_menu_file_new ()
 
virtual void on_menu_file_exit ()
 
virtual void on_menu_edit_cut ()
 
- Public Member Functions inherited from Bakery::App_Gtk
 App_Gtk (const Glib::ustring &appname)
 Don't forget to call init() too. More...
 
 App_Gtk (BaseObjectType *cobject, const Glib::ustring &appname)
 This constructor can be used to implement derived classes for use with Gnome::Glade::Xml::get_derived_widget(). More...
 
virtual ~App_Gtk ()
 
virtual void add (Gtk::Widget &child)
 Overidden to add a widget in the middle, under the menu, instead of replacing the whole contents. More...
 

Protected Member Functions

virtual void init_menus_file ()
 Call this from init_menus() to add the standard file menu. More...
 
virtual void init_menus_file_recentfiles (const Glib::ustring &path)
 
virtual void init_toolbars ()
 
virtual void document_history_add (const Glib::ustring &file_uri)
 
virtual void document_history_remove (const Glib::ustring &file_uri)
 
virtual void update_window_title ()
 
virtual void ui_warning (const Glib::ustring &text, const Glib::ustring &secondary_text)
 
virtual Glib::ustring ui_file_select_open (const Glib::ustring &starting_folder_uri=Glib::ustring())
 
virtual Glib::ustring ui_file_select_save (const Glib::ustring &old_file_uri)
 Present a user interface that allows the user to select a location to save the file. More...
 
virtual void ui_show_modification_status ()
 
virtual enumSaveChanges ui_offer_to_save_changes ()
 
void on_recent_files_activate (Gtk::RecentChooser &recent_chooser)
 
- Protected Member Functions inherited from Bakery::App_WithDoc
virtual void init_create_document ()
 
virtual Documentget_document ()
 static_cast<> or dynamic_cast<> this pointer to the correct type. More...
 
virtual const Documentget_document () const
 static_cast<> or dynamic_cast<> this pointer to the correct type. More...
 
virtual void set_document_modified (bool bModified=true)
 
virtual bool open_document (const Glib::ustring &file_uri)
 Open the document from a file at a URI. More...
 
bool open_document_from_data (const guchar *data, std::size_t length)
 Open the document using the supplied document contents. More...
 
virtual void on_document_modified (bool modified)
 Update visual status. More...
 
virtual bool on_document_load ()
 override this to show document contents. More...
 
virtual void offer_to_save_changes ()
 
virtual void cancel_close_or_exit ()
 Stop the File|Close or the File|Exit. More...
 
virtual void close_mark_or_destroy ()
 destroy it or mark it for destruction. More...
 
virtual void after_successful_save ()
 
- Protected Member Functions inherited from Bakery::App
virtual Appnew_instance ()=0
 
- Protected Member Functions inherited from Bakery::App_Gtk
virtual void init_ui_manager ()
 Builds the intial ui string, with placeholders. More...
 
virtual void init_menus ()
 Override this to add more menus or different menus. More...
 
virtual void init_menus_edit ()
 Call this from init_menus() to add the standard edit menu. More...
 
virtual void init_menus_help ()
 Call this from init_menus() to add the standard help menu. More...
 
virtual void init_layout ()
 
virtual void add_ui_from_string (const Glib::ustring &ui_description)
 
virtual void on_hide ()
 
virtual void on_menu_help_about ()
 
virtual void on_about_close ()
 
virtual void ui_hide ()
 
virtual void ui_bring_to_front ()
 
virtual bool on_delete_event (GdkEventAny *event)
 

Protected Attributes

Glib::RefPtr< Gtk::Action > m_action_save
 
Glib::RefPtr< Gtk::Action > m_action_saveas
 
- Protected Attributes inherited from Bakery::App_WithDoc
Documentm_pDocument
 
bool m_bCloseAfterSave
 
- Protected Attributes inherited from Bakery::App
type_signal_hide m_signal_hide
 
- Protected Attributes inherited from Bakery::App_Gtk
Glib::RefPtr< Gtk::UIManager > m_refUIManager
 
Glib::RefPtr< Gtk::ActionGroup > m_refFileActionGroup
 
Glib::RefPtr< Gtk::ActionGroup > m_refEditActionGroup
 
Glib::RefPtr< Gtk::ActionGroup > m_refHelpActionGroup
 
Gtk::VBox * m_pVBox
 
Gtk::VBox m_VBox_PlaceHolder
 
Gtk::HandleBox m_HandleBox_Toolbar
 

Additional Inherited Members

- Public Types inherited from Bakery::App_WithDoc
enum  enumSaveChanges { SAVECHANGES_Save, SAVECHANGES_Cancel, SAVECHANGES_Discard }
 
- Public Types inherited from Bakery::App
typedef std::vector< Glib::ustring > type_vecStrings
 
typedef sigc::signal< void > type_signal_hide
 
- Public Types inherited from Bakery::App_Gtk
typedef Gtk::Window ParentWindow
 
- Static Public Member Functions inherited from Bakery::App_WithDoc
static bool file_exists (const Glib::ustring &uri)
 
- Static Public Member Functions inherited from Bakery::App
static void set_about_information (const Glib::ustring &strVersion, const type_vecStrings &vecAuthors, const Glib::ustring &strCopyright, const Glib::ustring &strDescription)
 
static void set_about_information (const Glib::ustring &strVersion, const type_vecStrings &vecAuthors, const Glib::ustring &strCopyright, const Glib::ustring &strDescription, const type_vecStrings &vecDocumenters, const Glib::ustring &strTranslatorCredits)
 
static void set_command_line_args (int argc, char **&argv)
 
- Static Public Member Functions inherited from Bakery::App_Gtk
static Glib::ustring util_bold_message (const Glib::ustring &message)
 For instance, to create bold primary text for a dialog box, without marking the markup for translation. More...
 
- Protected Types inherited from Bakery::App_WithDoc
typedef std::list< Glib::ustring > type_list_strings
 
- Static Protected Member Functions inherited from Bakery::App_WithDoc
static void add_mime_type (const Glib::ustring &mime_type)
 Add a MIME-type that this application can support. More...
 
static Glib::ustring get_conf_fullkey (const Glib::ustring &key)
 
- Static Protected Member Functions inherited from Bakery::App
static void init_app_name (const Glib::ustring &appname)
 
static void set_operation_cancelled (bool bVal=true)
 
static bool get_operation_cancelled ()
 
- Static Protected Attributes inherited from Bakery::App_WithDoc
static type_list_strings m_mime_types
 
- Static Protected Attributes inherited from Bakery::App
static Glib::ustring m_strAppName
 
static HelpInfo m_HelpInfo
 
static AppInstanceManager m_AppInstanceManager
 
static bool m_bOperationCancelled
 
static bool m_bAboutShown
 
static Glib::ustring m_strCommandLine_0
 
- Static Protected Attributes inherited from Bakery::App_Gtk
static Gtk::Window * m_pAbout
 

Detailed Description

This class implements Bakery::App_WithDoc using gtkmm.

Your application's installation should register your document's MIME-type in GNOME's (freedesktop's) MIME-type system, and register your application as capable of opening documents of that MIME-type.

Constructor & Destructor Documentation

◆ App_WithDoc_Gtk() [1/2]

Bakery::App_WithDoc_Gtk::App_WithDoc_Gtk ( const Glib::ustring &  appname)

Don't forget to call init() too.

◆ App_WithDoc_Gtk() [2/2]

Bakery::App_WithDoc_Gtk::App_WithDoc_Gtk ( BaseObjectType *  cobject,
const Glib::ustring &  appname 
)

This constructor can be used to implement derived classes for use with Gnome::Glade::Xml::get_derived_widget().

◆ ~App_WithDoc_Gtk()

virtual Bakery::App_WithDoc_Gtk::~App_WithDoc_Gtk ( )
virtual

Member Function Documentation

◆ document_history_add()

virtual void Bakery::App_WithDoc_Gtk::document_history_add ( const Glib::ustring &  file_uri)
protectedvirtual

Reimplemented from Bakery::App_WithDoc.

◆ document_history_remove()

virtual void Bakery::App_WithDoc_Gtk::document_history_remove ( const Glib::ustring &  file_uri)
protectedvirtual

Reimplemented from Bakery::App_WithDoc.

◆ init()

virtual void Bakery::App_WithDoc_Gtk::init ( )
virtual

Reimplemented from Bakery::App_Gtk.

◆ init_menus_file()

virtual void Bakery::App_WithDoc_Gtk::init_menus_file ( )
protectedvirtual

Call this from init_menus() to add the standard file menu.

Reimplemented from Bakery::App_Gtk.

◆ init_menus_file_recentfiles()

virtual void Bakery::App_WithDoc_Gtk::init_menus_file_recentfiles ( const Glib::ustring &  path)
protectedvirtual

◆ init_toolbars()

virtual void Bakery::App_WithDoc_Gtk::init_toolbars ( )
protectedvirtual

Reimplemented from Bakery::App_Gtk.

◆ on_recent_files_activate()

void Bakery::App_WithDoc_Gtk::on_recent_files_activate ( Gtk::RecentChooser &  recent_chooser)
protected

◆ ui_file_select_open()

virtual Glib::ustring Bakery::App_WithDoc_Gtk::ui_file_select_open ( const Glib::ustring &  starting_folder_uri = Glib::ustring())
protectedvirtual

Implements Bakery::App_WithDoc.

◆ ui_file_select_save()

virtual Glib::ustring Bakery::App_WithDoc_Gtk::ui_file_select_save ( const Glib::ustring &  old_file_uri)
protectedvirtual

Present a user interface that allows the user to select a location to save the file.

Parameters
old_file_uriThe existing URI of the file, if any.
Returns
The URI of the file chosen by the user.

Implements Bakery::App_WithDoc.

◆ ui_offer_to_save_changes()

virtual enumSaveChanges Bakery::App_WithDoc_Gtk::ui_offer_to_save_changes ( )
protectedvirtual

Implements Bakery::App_WithDoc.

◆ ui_show_modification_status()

virtual void Bakery::App_WithDoc_Gtk::ui_show_modification_status ( )
protectedvirtual

Implements Bakery::App_WithDoc.

◆ ui_warning()

virtual void Bakery::App_WithDoc_Gtk::ui_warning ( const Glib::ustring &  text,
const Glib::ustring &  secondary_text 
)
protectedvirtual

Implements Bakery::App_WithDoc.

◆ update_window_title()

virtual void Bakery::App_WithDoc_Gtk::update_window_title ( )
protectedvirtual

Reimplemented from Bakery::App_WithDoc.

Member Data Documentation

◆ m_action_save

Glib::RefPtr<Gtk::Action> Bakery::App_WithDoc_Gtk::m_action_save
protected

◆ m_action_saveas

Glib::RefPtr<Gtk::Action> Bakery::App_WithDoc_Gtk::m_action_saveas
protected

The documentation for this class was generated from the following file: