preferencesEntry.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: preferencesEntry.h,v 1.10.16.1 2007/03/25 21:26:02 oliver Exp $
//

#ifndef BALL_VIEW_KERNEL_PREFERENCES_ENTRY
#define BALL_VIEW_KERNEL_PREFERENCES_ENTRY

#ifndef BALL_FORMAT_INIFILE_H
# include <BALL/FORMAT/INIFile.h>
#endif

#ifndef BALL_DATATYPE_HASHSET_H
# include <BALL/DATATYPE/hashSet.h>
#endif


class QWidget;
class QObject;
class QStackedWidget;

namespace BALL
{
  class INIFile;

  namespace VIEW
  {
    class BALL_VIEW_EXPORT PreferencesEntry
    {
      public:

      class BALL_VIEW_EXPORT ExtendedPreferencesObject
      {
        public:

        ExtendedPreferencesObject() {};

        virtual ~ExtendedPreferencesObject() {};

        virtual bool getValue(String&) const = 0;

        virtual bool setValue(const String&) = 0;
      };

      typedef std::list<std::pair<QWidget*, String> > StackPages;

      PreferencesEntry();

      virtual ~PreferencesEntry();

      virtual void writePreferenceEntries(INIFile& inifile);

      virtual void readPreferenceEntries(const INIFile& inifile);

      void setINIFileSectionName(const String& name) { inifile_section_name_ = name;}

      const String& getINIFileSectionName() const { return inifile_section_name_;}

      void setWidgetStackName(const String& name);

      StackPages& getStackPages() { return stack_pages_;}

      void setWidgetStack(QStackedWidget* stack);

      virtual void showStackPage(Position nr);

      virtual void showStackPage(QWidget* widget);

      virtual Position currentStackPage() const;

      virtual void restoreDefaultValues(bool all = false);

      virtual void storeValues();

      virtual void restoreValues(bool all = false);

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

      virtual bool setValueAllowed(QObject* /*widget*/) { return true; }

      protected:

      typedef HashMap<const QObject*, String> ValueMap;

      void registerWidgets_();

      /*_ Registration for objects, that are not automatically supported.
          Should no be needed, but if the need should arive, call it in the constructor of the derived class.
      */
      void registerObject_(QObject* widget);

      /*_ Unregistration for objects, that are automatically registered.
          Should no be needed, but if the need should arive, call it in the constructor of the derived class
          after registerWidgets_()
      */
      void unregisterObject_(QObject* widget);

      void registerWidgetForHelpSystem_(const QWidget* widget, const String& url);

      //_ Helper function to restore the values of the current stack widget or all values
      void restoreValues_(bool all, const ValueMap& map);

      //_ Add a stack entry
      void insertStackEntry_(QWidget*, const String& name);

      //_ Check if the object's data can be transformed into a string
      bool isSupported_(QObject& widget);

      //_ Transform the object's data into a string
      bool getValue_(const QObject* widget, String& value);

      //_ Restore the widget's data from a string
      bool setValue_(QObject* widget, const String& value);

      // name for the section in the INIFile
      String inifile_section_name_;

      // all registered child objects
      HashSet<QObject*> registered_objects_;

      // stored default and last values for each registered object
      ValueMap default_values_, last_values_;

      // if the derived class has its own QStackedWidget, it is stored here
      QStackedWidget* widget_stack_;

      StackPages stack_pages_;
    };

  } // namespace VIEW
} // namespace BALL

#endif // BALL_VIEW_KERNEL_PREFERENCES_ENTRY