Changeset 0c6e731fde2f0fa4c225215371d356fed6d6f6f3

Timestamp:

01/06/07 23:57:58 (6 years ago)

Author:

Philipp Kern <phil@…>

Parents:

ba89078f762f9261827bc9091e642ac272644d35

Children:

1662ea7cb97e74c04650ddda1130c2ea7a4d07ce

git-committer:

Philipp Kern <phil@0x539.de> / 2007-01-06T22:57:58Z+0000

Message:

[project @ Added application state frags controlling header sensitivity]

Original author: Armin Burgmeier <armin@…>
Date: 2006-03-07 17:22:46+00:00

Files:

• Makefile.am (modified) (2 diffs)
• inc/application_state.hpp (added)
• inc/folder.hpp (modified) (4 diffs)
• inc/header.hpp (modified) (6 diffs)
• inc/window.hpp (modified) (2 diffs)
• src/application_state.cpp (added)
• src/folder.cpp (modified) (6 diffs)
• src/header.cpp (modified) (4 diffs)
• src/window.cpp (modified) (13 diffs)

Makefile.am

@@ -23 +23 @@
 noinst_HEADERS += inc/mimemap.hpp
 noinst_HEADERS += inc/regex.hpp
+noinst_HEADERS += inc/application_state.hpp
 noinst_HEADERS += inc/encoding_selector.hpp
 noinst_HEADERS += inc/defaultdialog.hpp
@@ -77 +78 @@
 gobby_SOURCES += src/mimemap.cpp
 gobby_SOURCES += src/regex.cpp
+gobby_SOURCES += src/application_state.cpp
 gobby_SOURCES += src/encoding_selector.cpp
 gobby_SOURCES += src/defaultdialog.cpp

inc/folder.hpp

@@ -130 +130 @@
                 tab_switched_event() const;
 protected:
-        /** Parameter type for the internal enable_document_items function.
-         */
-        enum DocumentItems {
-                /** Disable all document items.
-                 */
-                DOCUMENT_ITEMS_DISABLE_ALL = 0,
-
-                /** Enable only document items which are useful even if the
-                 * user is not subscribed to the document, disable others.
-                 */
-                DOCUMENT_ITEMS_ENABLE_DISCONN = 1,
-
-                /** Enable all document items.
-                 */
-                DOCUMENT_ITEMS_ENABLE_ALL = 2
-        };
-
         // Overrides
         virtual void on_switch_page(GtkNotebookPage* page, guint page_num);
@@ -154 +137 @@
         // Internals
         void set_tab_colour(DocWindow& win, const Glib::ustring& colour);
-        void enable_document_items(DocumentItems which);
 
         // Signal handlers
@@ -180 +162 @@
         signal_document_remove_type
                 m_signal_document_remove;
+
         signal_document_close_request_type
                 m_signal_document_close_request;
@@ -188 +171 @@
         signal_document_language_changed_type
                 m_signal_document_language_changed;
+
         signal_tab_switched_type
                 m_signal_tab_switched;

inc/header.hpp

@@ -20 +20 @@
 #define _GOBBY_HEADER_HPP_
 
+#include <list>
+
 #include <gtkmm/box.h>
 #include <gtkmm/uimanager.h>
@@ -26 +28 @@
 #include <gtkmm/toolbar.h>
 
+#include "application_state.hpp"
 #include "sourceview/sourcelanguage.hpp"
 #include "sourceview/sourcelanguagesmanager.hpp"
@@ -47 +50 @@
         };
 
+        /** @brief Action that automatically chances sensitivity depending
+         * on application state.
+         */
+        class AutoAction
+        {
+        public:
+                typedef Glib::RefPtr<Gtk::Action> action_type;
+
+                AutoAction(action_type action,
+                           const ApplicationState& state,
+                           ApplicationFlags inc_flags,
+                           ApplicationFlags exc_flags);
+
+        protected:
+                void on_state_change(const ApplicationState& state);
+
+                action_type m_action;
+                ApplicationFlags m_inc_flags;
+                ApplicationFlags m_exc_flags;
+        };
+
+        /** @brief Class that stores multiple AutoActions.
+         *
+         * Once an AutoAction has been created, it works without any further
+         * need to access the AutoAction object again, one just needs to
+         * keep the AutoAction somewhere and release it when the application
+         * exits.
+         *
+         * So this class does just keep auto actions without providing access
+         * to them.
+         */
+        class AutoList
+        {
+        public:
+                typedef AutoAction::action_type action_type;
+
+                void add(action_type action,
+                         const ApplicationState& state,
+                         ApplicationFlags inc_flags,
+                         ApplicationFlags exc_flags);
+
+                ~AutoList();
+
+        protected:
+                std::list<AutoAction*> m_list;
+        };
+
         class LanguageWrapper
         {
         public:
+                //typedef AutoAction<Gtk::RadioAction> Action;
                 typedef Glib::RefPtr<Gtk::RadioAction> Action;
                 typedef Glib::RefPtr<Gtk::SourceLanguage> Language;
@@ -63 +114 @@
         };
 
-        Header();
+        Header(const ApplicationState& state);
 
         // Access to accelerator groups of the ui manager
@@ -123 +174 @@
 
 protected:
+        void set_action_auto(const Glib::RefPtr<Gtk::Action>& action,
+                             const ApplicationState& state,
+                             ApplicationFlags inc_flags,
+                             ApplicationFlags exc_flags);
+
         const Glib::RefPtr<Gtk::UIManager> m_ui_manager;
         Glib::RefPtr<Gtk::SourceLanguagesManager> m_lang_manager;
@@ -130 +186 @@
 
         Gtk::RadioButtonGroup m_lang_group;
+
+        /** @brief List that just stores internally the auto actions to have
+         * the actions change sensitivity automatically.
+         */
+        AutoList m_auto_actions;
 };
 

inc/window.hpp

@@ -24 +24 @@
 #include <gtkmm/frame.h>
 #include <gtkmm/messagedialog.h>
+
 #include "features.hpp"
 #include "icon.hpp"
 #include "config.hpp"
+#include "application_state.hpp"
 #include "header.hpp"
 #include "docwindow.hpp"
@@ -148 +150 @@
         Gtk::Frame m_frame_text;
 
+        ApplicationState m_application_state;
         DocumentSettings m_document_settings;
 

src/folder.cpp

@@ -116 +116 @@
                       const Preferences& preferences):
         Gtk::Notebook(),
-        m_block_language(false), m_header(header), m_preferences(preferences), m_buffer(NULL)
+        m_block_language(false), m_header(header), m_preferences(preferences),
+        m_buffer(NULL)
 {
         set_scrollable(true);
@@ -156 +157 @@
                 remove_page(0);
 
-        // Disable all document items, there are no documents upon start
-        enable_document_items(DOCUMENT_ITEMS_DISABLE_ALL);
-
         set_sensitive(true);
         m_buffer = &buf;
@@ -170 +168 @@
         // the documents
         for(int i = 0; i < get_n_pages(); ++ i)
-                static_cast<DocWindow*>(get_nth_page(i) )->disable(); //get_document().set_sensitive(false);
-
-        // Disable some items, but let save and close still active.
-        // Disable all if the last document has been closed.
-        if(get_n_pages() > 0)
-                enable_document_items(DOCUMENT_ITEMS_ENABLE_DISCONN);
+                static_cast<DocWindow*>(get_nth_page(i) )->disable();
 }
 
 void Gobby::Folder::obby_user_join(const obby::user& user)
 {
-        // Pass user join event to documents
-        //for(unsigned int i = 0; i < get_n_pages(); ++ i)
-        //      static_cast<DocWindow*>(get_nth_page(i) )->obby_user_join(user);
 }
 
 void Gobby::Folder::obby_user_part(const obby::user& user)
 {
-        // Pass user part event to documents
-        //for(unsigned int i = 0; i < get_n_pages(); ++ i)
-        //      static_cast<DocWindow*>(get_nth_page(i) )->obby_user_part(user);
 }
 
 void Gobby::Folder::obby_user_colour(const obby::user& user)
 {
-        // Pass user colour event to documents
-        //for(unsigned int i = 0; i < get_n_pages(); ++ i)
-        //      static_cast<DocWindow*>(
-        //              get_nth_page(i) )->obby_user_colour(user);
 }
 
@@ -303 +286 @@
 }
 
-void Gobby::Folder::enable_document_items(DocumentItems which)
-{
-        m_header.action_session_document_save->
-                set_sensitive(which >= DOCUMENT_ITEMS_ENABLE_DISCONN);
-        m_header.action_session_document_save_as->
-                set_sensitive(which >= DOCUMENT_ITEMS_ENABLE_DISCONN);
-        m_header.action_session_document_close->
-                set_sensitive(which >= DOCUMENT_ITEMS_ENABLE_DISCONN);
-        m_header.action_view_preferences->
-                set_sensitive(which >= DOCUMENT_ITEMS_ENABLE_DISCONN);
-        m_header.action_view_syntax->
-                set_sensitive(which >= DOCUMENT_ITEMS_ENABLE_DISCONN);
-}
-
 void Gobby::Folder::on_language_changed(const Glib::RefPtr<Gtk::SourceLanguage>& language)
 {
@@ -421 +390 @@
         new_wnd->show_all();
 
-        // Enable document items as there is at least one document we are
-        // subscribed to.
-        enable_document_items(DOCUMENT_ITEMS_ENABLE_ALL);
-
         // Emit add_document signal
         m_signal_document_add.emit(*new_wnd);
@@ -457 +422 @@
         // is Gtk::managed
         m_signal_document_remove.emit(*wnd);
-
-        if(get_n_pages() == 0)
-        {
-                // Disable document items if there are no more documents left
-                enable_document_items(DOCUMENT_ITEMS_DISABLE_ALL);
-        }
 
         // The next time the user subscribes the DocWindow will be

src/header.cpp

@@ -150 +150 @@
 }
 
+Gobby::Header::AutoAction::AutoAction(action_type action,
+                                      const ApplicationState& state,
+                                      ApplicationFlags inc_flags,
+                                      ApplicationFlags exc_flags):
+        m_action(action), m_inc_flags(inc_flags), m_exc_flags(exc_flags)
+{
+        state.state_changed_event().connect(
+                sigc::bind(
+                        sigc::hide(
+                                sigc::mem_fun(
+                                        *this,
+                                        &AutoAction::on_state_change
+                                )
+                        ),
+                        sigc::ref(state)
+                )
+        );
+}
+
+void Gobby::Header::AutoAction::on_state_change(const ApplicationState& state)
+{
+        m_action->set_sensitive(state.query(m_inc_flags, m_exc_flags) );
+}
+
+void Gobby::Header::AutoList::add(action_type action,
+                                  const ApplicationState& state,
+                                  ApplicationFlags inc_flags,
+                                  ApplicationFlags exc_flags)
+{
+        m_list.push_back(new AutoAction(action, state, inc_flags, exc_flags) );
+}
+
+Gobby::Header::AutoList::~AutoList()
+{
+        for(std::list<AutoAction*>::iterator iter = m_list.begin();
+            iter != m_list.end();
+            ++ iter)
+        {
+                delete *iter;
+        }
+}
+
 Gobby::Header::Error::Error(Code error_code, const Glib::ustring& error_message)
  : Glib::Error(g_quark_from_static_string("GOBBY_HEADER_ERROR"),
@@ -161 +203 @@
 }
 
-Gobby::Header::Header():
+Gobby::Header::Header(const ApplicationState& state):
         group_app(Gtk::ActionGroup::create() ),
         group_session(Gtk::ActionGroup::create() ),
@@ -370 +412 @@
         m_lang_manager(Gtk::SourceLanguagesManager::create() )
 {
+        // Assign auto actions
+        set_action_auto(
+                action_app, state,
+                APPLICATION_NONE, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_app_session_create, state,
+                APPLICATION_NONE, APPLICATION_SESSION
+        );
+
+        set_action_auto(
+                action_app_session_join, state,
+                APPLICATION_NONE, APPLICATION_SESSION
+        );
+
+        set_action_auto(
+                action_app_session_save, state,
+                APPLICATION_NONE, APPLICATION_INITIAL
+        );
+
+        set_action_auto(
+                action_app_session_quit, state,
+                APPLICATION_SESSION, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_app_quit, state,
+                APPLICATION_NONE, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_session, state,
+                APPLICATION_NONE, APPLICATION_INITIAL
+        );
+
+        set_action_auto(
+                action_session_document_create, state,
+                APPLICATION_SESSION, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_session_document_open, state,
+                APPLICATION_SESSION, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_session_document_save, state,
+                APPLICATION_DOCUMENT, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_session_document_save_as, state,
+                APPLICATION_DOCUMENT, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_session_document_close, state,
+                APPLICATION_DOCUMENT, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_edit, state,
+                APPLICATION_NONE, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_edit_search, state,
+                APPLICATION_NONE, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_edit_search_replace, state,
+                APPLICATION_NONE, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_edit_goto_line, state,
+                APPLICATION_NONE, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_edit_preferences, state,
+                APPLICATION_NONE, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_user, state,
+                APPLICATION_SESSION, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_user_set_password, state,
+                APPLICATION_SESSION, APPLICATION_HOST
+        );
+
+        set_action_auto(
+                action_user_set_colour, state,
+                APPLICATION_SESSION, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_view, state,
+                APPLICATION_DOCUMENT, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_view_preferences, state,
+                APPLICATION_DOCUMENT, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_view_syntax, state,
+                APPLICATION_DOCUMENT, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_window, state,
+                APPLICATION_NONE, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_window_userlist, state,
+                APPLICATION_NONE, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_window_documentlist, state,
+                APPLICATION_NONE, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_help, state,
+                APPLICATION_NONE, APPLICATION_NONE
+        );
+
+        set_action_auto(
+                action_help_about, state,
+                APPLICATION_NONE, APPLICATION_NONE
+        );
+
         // Add basic menu
         m_ui_manager->add_ui_from_string(ui_desc);
@@ -545 +728 @@
         return *m_toolbar;
 }
+
+void Gobby::Header::set_action_auto(const Glib::RefPtr<Gtk::Action>& action,
+                                    const ApplicationState& state,
+                                    ApplicationFlags inc_flags,
+                                    ApplicationFlags exc_flags)
+{
+        m_auto_actions.add(action, state, inc_flags, exc_flags);
+}
+

src/window.cpp

@@ -55 +55 @@
         m_zeroconf(NULL),
 #endif
-        m_document_settings(*this), m_header(),
+        m_application_state(APPLICATION_NONE),
+        m_document_settings(*this), m_header(m_application_state),
         m_userlist(*this, m_header, m_preferences, config["windows"]),
         m_documentlist(
@@ -127 +128 @@
         add_accel_group(m_header.get_accel_group() );
 
-        // Initialise header sensitivity
-        m_header.group_session->set_sensitive(false);
-        m_header.group_user->set_sensitive(false);
-        m_header.group_view->set_sensitive(false);
-        m_header.action_app_session_save->set_sensitive(false);
-        m_header.action_app_session_quit->set_sensitive(false);
-
         m_frame_chat.set_shadow_type(Gtk::SHADOW_IN);
         m_frame_text.set_shadow_type(Gtk::SHADOW_IN);
@@ -155 +149 @@
         set_title("Gobby");
         set_default_size(640, 480);
+
+        m_application_state.modify(APPLICATION_INITIAL, APPLICATION_NONE);
 
 #ifdef WITH_HOWL
@@ -232 +228 @@
 {
         if(m_buffer.get() == NULL) return false;
+        if(!m_buffer->is_open() ) return false;
 
         Gtk::MessageDialog dlg(
@@ -272 +269 @@
         m_dnd.reset(new DragDrop(*this) );
 
-        m_header.group_session->set_sensitive(true);
-        m_header.action_session_document_create->set_sensitive(true);
-        m_header.action_session_document_open->set_sensitive(true);
-        m_header.group_user->set_sensitive(true);
-        m_header.group_view->set_sensitive(true);
-        m_header.action_app_session_save->set_sensitive(true);
-        m_header.action_app_session_quit->set_sensitive(true);
-
-        m_header.action_app_session_create->set_sensitive(false);
-        m_header.action_app_session_join->set_sensitive(false);
-
-        m_header.action_user_set_password->set_sensitive(
-                dynamic_cast<ClientBuffer*>(m_buffer.get()) != NULL
-        );
-
         // Delegate start of obby session
         m_folder.obby_start(*m_buffer);
@@ -311 +293 @@
 
         // Set last page as active one because it is currently shown anyway.
-        if(m_buffer->document_count() > 0)
-                m_folder.set_current_page(m_buffer->document_count() - 1);
+        //if(m_buffer->document_count() > 0)
+        //      m_folder.set_current_page(m_buffer->document_count() - 1);
 
         // Clear location of previous session file, this is a new session
@@ -326 +308 @@
                 m_documentlist.grab_focus();
         }
+
+        ApplicationFlags inc_flags = APPLICATION_SESSION;
+        ApplicationFlags exc_flags = APPLICATION_INITIAL | APPLICATION_DOCUMENT;
+
+        if(dynamic_cast<ClientBuffer*>(m_buffer.get()) != NULL)
+                exc_flags |= APPLICATION_HOST;
+        else
+                inc_flags |= APPLICATION_HOST;
+
+        m_application_state.modify(inc_flags, exc_flags);
 }
 
@@ -338 +330 @@
                 );
         }
+
+        m_application_state.modify(APPLICATION_NONE, APPLICATION_SESSION);
 
         if(m_buffer->is_open() )
@@ -361 +355 @@
         m_chat.obby_end();
         m_statusbar.obby_end();
-
-        m_header.action_session_document_create->set_sensitive(false);
-        m_header.action_session_document_open->set_sensitive(false);
-        m_header.group_user->set_sensitive(false);
-        //m_header.action_app_session_save->set_sensitive(false);
-        m_header.action_app_session_quit->set_sensitive(false);
-
-        m_header.action_app_session_create->set_sensitive(true);
-        m_header.action_app_session_join->set_sensitive(true);
 
 #ifdef WITH_HOWL
@@ -604 +589 @@
         // Select newly created page
         m_folder.set_current_page(m_folder.page_num(window) );
-        window.grab_focus(); // TODO: Grab focus to sourceview...
+        window.grab_focus();
+
+        if(m_folder.get_n_pages() == 1)
+        {
+                // There have not been any documents before
+                m_application_state.modify(
+                        APPLICATION_DOCUMENT,
+                        APPLICATION_NONE
+                );
+        }
 }
 
@@ -615 +609 @@
                 update_title_bar();
 
-                // TODO: This should be done automatically with flags for the
-                // menu items which specify when the entry is visible
-                if(m_buffer.get() == NULL || !m_buffer->is_open())
-                {
-                        m_header.group_session->set_sensitive(false);
-                        m_header.group_view->set_sensitive(false);
-                }
+                m_application_state.modify(
+                        APPLICATION_NONE,
+                        APPLICATION_DOCUMENT
+                );
         }
 }
@@ -1307 +1298 @@
         }
 
-//      if(m_buffer.get() != NULL)
-//      {
-                // Unsubscribe from document
-                window.get_info().unsubscribe();
-//      }
-//      else
-//      {
-                // Buffer does not exist: Maybe the connection has been lost
-                // or something: Just remove the document from the folder.
-//              m_folder.remove_page(window);
-//              on_folder_document_remove(window);
-//      }
+        window.get_info().unsubscribe();
 }
 
@@ -1328 +1308 @@
         dlg.run();
 }
-