bakery  2.6
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
Bakery::App Class Referenceabstract

Bakery's Main Window. More...

#include <App.h>

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

Public Types

typedef std::vector
< Glib::ustring > 
type_vecStrings
 
typedef sigc::signal< void > type_signal_hide
 

Public Member Functions

 App (const Glib::ustring &appname=Glib::ustring())
 Don't forget to call init() too. More...
 
virtual ~App ()
 
virtual void init ()
 
virtual Glib::ustring get_version () const
 
type_signal_hide ui_signal_hide ()
 
virtual void on_menu_file_new ()
 
virtual void on_menu_file_close ()
 
virtual void on_menu_file_exit ()
 
virtual void on_menu_edit_cut ()
 
virtual void on_menu_edit_copy ()
 
virtual void on_menu_edit_paste ()
 
virtual void on_menu_edit_clear ()
 
virtual void on_menu_help_about ()=0
 
virtual void on_about_close ()
 

Static Public Member Functions

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)
 

Protected Member Functions

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_file ()=0
 Call this from init_menus() to add the standard file menu. More...
 
virtual void init_menus_edit ()=0
 Call this from init_menus() to add the standard edit menu. More...
 
virtual void init_menus_help ()=0
 Call this from init_menus() to add the standard help menu. More...
 
virtual void init_toolbars ()
 
virtual Appnew_instance ()=0
 
virtual void ui_hide ()=0
 
virtual void ui_bring_to_front ()=0
 

Static Protected Member Functions

static void init_app_name (const Glib::ustring &appname)
 
static void set_operation_cancelled (bool bVal=true)
 
static bool get_operation_cancelled ()
 

Protected Attributes

type_signal_hide m_signal_hide
 

Static Protected Attributes

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
 

Friends

class AppInstanceManager
 

Detailed Description

Bakery's Main Window.

This is an abstract class. You must use a class such as App_Gtk, which implements the ui_* methods for a particular GUI toolkit.

Features:

TODO:

Member Typedef Documentation

typedef sigc::signal<void> Bakery::App::type_signal_hide
typedef std::vector<Glib::ustring> Bakery::App::type_vecStrings

Constructor & Destructor Documentation

Bakery::App::App ( const Glib::ustring &  appname = Glib::ustring())

Don't forget to call init() too.

virtual Bakery::App::~App ( )
virtual

Member Function Documentation

static bool Bakery::App::get_operation_cancelled ( )
staticprotected
virtual Glib::ustring Bakery::App::get_version ( ) const
virtual
virtual void Bakery::App::init ( )
virtual
static void Bakery::App::init_app_name ( const Glib::ustring &  appname)
staticprotected
virtual void Bakery::App::init_menus ( )
protectedvirtual

Override this to add more menus or different menus.

Reimplemented in Bakery::App_Gtk.

virtual void Bakery::App::init_menus_edit ( )
protectedpure virtual

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

Implemented in Bakery::App_Gtk.

virtual void Bakery::App::init_menus_file ( )
protectedpure virtual

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

Implemented in Bakery::App_Gtk, and Bakery::App_WithDoc_Gtk.

virtual void Bakery::App::init_menus_help ( )
protectedpure virtual

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

Implemented in Bakery::App_Gtk.

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

Reimplemented in Bakery::App_Gtk, and Bakery::App_WithDoc_Gtk.

virtual void Bakery::App::init_ui_manager ( )
protectedvirtual

Builds the intial ui string, with placeholders.

This allows us to merge in actual menus and toolbars in the other init_*() methods.

Reimplemented in Bakery::App_Gtk.

virtual App* Bakery::App::new_instance ( )
protectedpure virtual
virtual void Bakery::App::on_about_close ( )
virtual

Reimplemented in Bakery::App_Gtk.

virtual void Bakery::App::on_menu_edit_clear ( )
virtual

Reimplemented in Bakery::App_WithDoc.

virtual void Bakery::App::on_menu_edit_copy ( )
virtual

Reimplemented in Bakery::App_WithDoc.

virtual void Bakery::App::on_menu_edit_cut ( )
virtual
virtual void Bakery::App::on_menu_edit_paste ( )
virtual

Reimplemented in Bakery::App_WithDoc.

virtual void Bakery::App::on_menu_file_close ( )
virtual

Reimplemented in Bakery::App_WithDoc.

virtual void Bakery::App::on_menu_file_exit ( )
virtual
virtual void Bakery::App::on_menu_file_new ( )
virtual
virtual void Bakery::App::on_menu_help_about ( )
pure virtual

Implemented in Bakery::App_Gtk.

static void Bakery::App::set_about_information ( const Glib::ustring &  strVersion,
const type_vecStrings vecAuthors,
const Glib::ustring &  strCopyright,
const Glib::ustring &  strDescription 
)
static
static void Bakery::App::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
static void Bakery::App::set_command_line_args ( int  argc,
char **&  argv 
)
static
static void Bakery::App::set_operation_cancelled ( bool  bVal = true)
staticprotected
virtual void Bakery::App::ui_bring_to_front ( )
protectedpure virtual

Implemented in Bakery::App_Gtk.

virtual void Bakery::App::ui_hide ( )
protectedpure virtual

Implemented in Bakery::App_Gtk.

type_signal_hide Bakery::App::ui_signal_hide ( )

Friends And Related Function Documentation

friend class AppInstanceManager
friend

Member Data Documentation

AppInstanceManager Bakery::App::m_AppInstanceManager
staticprotected
bool Bakery::App::m_bAboutShown
staticprotected
bool Bakery::App::m_bOperationCancelled
staticprotected
HelpInfo Bakery::App::m_HelpInfo
staticprotected
type_signal_hide Bakery::App::m_signal_hide
protected
Glib::ustring Bakery::App::m_strAppName
staticprotected
Glib::ustring Bakery::App::m_strCommandLine_0
staticprotected

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