helpViewer.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: helpViewer.h,v 1.2.18.1 2007/03/25 21:26:21 oliver Exp $
//
 
#ifndef BALL_VIEW_WIDGETS_HELPVIEWER_H
#define BALL_VIEW_WIDGETS_HELPVIEWER_H
 
#ifndef BALL_VIEW_WIDGETS_DOCKWIDGET_H
# include <BALL/VIEW/WIDGETS/dockWidget.h>
#endif
 
#include <QtWidgets/QTextBrowser>
 
namespace BALL
{
  namespace VIEW
  {

    class BALL_DEPRECATED BALL_VIEW_EXPORT MyTextBrowser
      : public QTextBrowser
    {
      Q_OBJECT
 
      public:
 
      MyTextBrowser(QWidget* parent, const char* name = 0);
 
      protected:
 
      bool forward_, backward_;
    };

    class BALL_DEPRECATED BALL_VIEW_EXPORT HelpViewer
      : public DockWidget
    {
      Q_OBJECT
 
      public:
 
      BALL_EMBEDDABLE(HelpViewer, DockWidget)
 
      
      HelpViewer(QWidget* parent, const char* name = 0);

      virtual ~HelpViewer();

      virtual void initializeWidget(MainControl& main_control);

      virtual void onNotify(Message *message);

      virtual void showHelp(const String& URL);

      virtual void showHelp(const String& URL, String entry);

      void setDefaultPage(const String& url);
    
      const String& getDefaultPage() const;

      void setProject(const String& project) { project_ = project;}

      String getProject() const { return project_;}
      
      void setBaseDirectory(const String& dir);
  
      const String& getBaseDirectory() const;

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

      void unregisterForHelpSystem(const QObject* object);

      bool showHelpFor(const QObject* object);

      bool showDocumentationForObject();

      bool hasHelpFor(const QObject* object) const;

      String getHelpEntryFor(const QObject* object) const;

      void setWhatsThisEnabled(bool state) { whats_this_ = state;}

      bool isWhatsThisEnabled() const {return whats_this_;}

      void showDocumentationFor(const String& classname, const String& member);
          
      public Q_SLOTS:

      virtual void showHelp();

      void enterWhatsThisMode();

      void exitWhatsThisMode();

      bool eventFilter(QObject* obj, QEvent* e);
    
      protected:
 
      void collectClasses_();
 
      String          project_;
      String          default_page_;
      String          base_dir_;
      MyTextBrowser*  browser_;
      bool            whats_this_mode_;
      bool            ignore_event_;
      bool            whats_this_;
      QAction*        whats_action_;
 
      HashMap<const QObject*, String> docu_entries_;
      StringHashMap<String> classes_to_files_;
    };
    
} } // namespaces
 
#endif // BALL_VIEW_WIDGETS_HELPVIEWER_H