modularWidget.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//

#ifndef BALL_VIEW_WIDGETS_MODULARWIDGET_H
#define BALL_VIEW_WIDGETS_MODULARWIDGET_H

#ifndef BALL_CONCEPT_EMBEDDABLE_H
# include <BALL/CONCEPT/embeddable.h>
#endif

#ifndef BALL_VIEW_KERNEL_CONNECTIONOBJECT_H
# include <BALL/VIEW/KERNEL/connectionObject.h>
#endif

#include <QtGui/QKeySequence>
#include <QtGui/QToolBar>

class QObject;
class QMenuBar;
class QWidget;
class QAction;

namespace BALL
{
  class INIFile;
  class FragmentDB;

  namespace VIEW
  {
    class Preferences;
    class MainControl;

    class BALL_VIEW_EXPORT ModularWidget
      : public Embeddable,  
        public ConnectionObject
    {
      public:
      
      BALL_EMBEDDABLE(ModularWidget,Embeddable)
      BALL_CREATE(ModularWidget)
      
      

      ModularWidget(const char* name = "<ModularWidget>");
        
      ModularWidget(const ModularWidget& widget);
        


      virtual ~ModularWidget();

      virtual void destroy()
        { clear(); };

      virtual void clear();


      
      static void registerWidget(ModularWidget* mwidget)
        throw(Exception::NullPointer);
        
      virtual void initializeWidget(MainControl& main_control);
      
      virtual void finalizeWidget(MainControl& main_control);

      virtual bool canHandle(const String& /*fileformat*/) const { return false;}

      virtual bool openFile(const String& /*filename*/) { return false;}


  
      virtual void checkMenu(MainControl& main_control);

      QAction* insertMenuEntry (Position parent_id, const String& name, const QObject* receiver = 0, 
                           const char* slot = 0, const String& description = "", QKeySequence accel = QKeySequence());

      void setMenuHint(const String& hint);

      void setMenuHelp(const String& url);

      virtual void registerForHelpSystem(const QObject* object, const String& url);

      virtual void addToolBarEntries(QToolBar* main_tb);

      void setIcon(const String& filename, bool add_to_main_toolbar = true);



      
      virtual void initializePreferencesTab(Preferences& preferences);
      
      virtual void finalizePreferencesTab(Preferences& preferences);
      
      virtual void applyPreferences(){};

      virtual void fetchPreferences(INIFile& inifile);
      
      virtual void writePreferences(INIFile& inifile);


      
      bool lockComposites();

      bool unlockComposites();



      MainControl* getMainControl() const;

      virtual void setStatusbarText(const String& text, bool important = false);

      virtual void setStatusbarText(const QString& text, bool important = false);

      String getWorkingDir();

      void setWorkingDir(const String& dir);

      FragmentDB& getFragmentDB() const;



      virtual void dump(std::ostream& s = std::cout, Size depth = 0) const;


      void setWorkingDirFromFilename_(String filename);

      virtual void showHelp(const String& url);

      protected:

      //_ id in the menubar entry "WINDOWS" for every widget
      QAction* window_menu_entry_;

      //_ should there be an entry to switch the window on and off?
      bool show_window_enty_;

      //_ should the widget be visible, if no config file entry exists?
      bool default_visible_;

      QAction* last_action_;
      QList<QAction*> main_toolbar_actions_;
    }; 
  
  } // namespace VIEW
} // namespace BALL

#endif // BALL_VIEW_WIDGETS_MODULARWIDGET_H