molecularControl.h

Go to the documentation of this file.

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

#ifndef BALL_VIEW_WIDGETS_MOLECULARCONTROL_H
#define BALL_VIEW_WIDGETS_MOLECULARCONTROL_H

#ifndef BALL_VIEW_WIDGETS_GENERICCONTROL_H
# include <BALL/VIEW/WIDGETS/genericControl.h>
#endif

#ifndef BALL_CONCEPT_MOLECULARINFORMATION_H
# include <BALL/CONCEPT/molecularInformation.h>
#endif

#ifndef BALL_SYSTEM_MUTEX_H
# include <BALL/SYSTEM/mutex.h>
#endif

#ifndef BALL_VIEW_KERNEL_COMMON_H
# include <BALL/VIEW/KERNEL/common.h>
#endif

#include <QtGui/QMenu>
#include <QtGui/QTreeView>

class QComboBox;
class QPoint;
class QSignalMapper;
class QThread;

namespace BALL
{
  class Residue;
  class RotamerLibrary;

  namespace VIEW
  {
    class BondProperties;

class BALL_VIEW_EXPORT MolecularControl
  : public GenericControl
{
  // for internal usage only:
  class MyTreeWidgetItem
    : public QTreeWidgetItem
  {
    public:

      MyTreeWidgetItem(QTreeWidget* parent, QStringList& sl, Composite* composite);

      MyTreeWidgetItem(QTreeWidgetItem* parent, QStringList& sl, Composite* composite);

      void init_();

      Composite* composite;
  };

  enum MolecularMenuEntries
  {
    CREATE_REPRESENTATION,
    OBJECT__MOVE,
    SELECT,
    DESELECT,
    EDIT_MENU,
    CUT,
    COPY,
    DELETE_ENTRY,
    PASTE,


    CAMERA__CENTER,
    COMPOSITE__PROPERTIES,
    COUNT__ITEMS,
    BOND__PROPERTIES,
    COLLAPSE_ALL,
    EXPAND_ALL
  };

  Q_OBJECT

  public:

  BALL_EMBEDDABLE(MolecularControl,GenericControl)

  friend class BondProperties;


  MolecularControl(QWidget* parent = 0, const char* name = 0);
  
  virtual ~MolecularControl();
  

  
  virtual void checkMenu(VIEW::MainControl& main_control);

  void addComposite(Composite& composite, String given_name = "");

  Size removeComposite(Composite& composite);

  const std::list<Composite*>& getSelection() const;

  Composite* getContextComposite();
  
  virtual void onNotify(Message *message);

  virtual void updateContextMenu(Composite& composite);

  virtual void initializeWidget(MainControl& main_control);

  Size applySelector(const String& expression);

  void writePreferences(INIFile& inifile);

  void fetchPreferences(INIFile& inifile);

  void showDistance(Atom* a1, Atom* a2);
  
  void showAngle(Atom* a1, Atom* a2, Atom* a3, Atom* a4 = 0);

  QMenu& getContextMenu();

  public slots:
    


  void createRepresentation();

  void compositeProperties();

  void toggleDisulfidBond();

  void bondProperties();

  void checkResidue();

  void buildBonds();
  
  void centerCamera();

  void countItems();

  void showFilename();

  virtual void updateSelection();

  void highlightSelection();

  void highlight(const std::list<Composite*>& composite);

  void cut();

  void copy();

  void paste();

  void clearClipboard();

  void select();
  
  void deselect();

  void moveItems();
  
  void collapseAll();

  void expandAll();

  Size applySelector();

  void showSelectorHelp();

  virtual void deleteCurrentItems();

  virtual void clearSelector();

  void switchShowSecondaryStructure();

  void showAtomOverview();

  void showAtomOverviewForSelection();

  void showDistance();
  
  void showAngle();
  

  protected slots:

  /*_ Controlling method for context menus.
      Clear the previously created context menu.
      Calls buildContextMenu for the Composite object belonging
      to the <tt>item</tt> and executes the context menu if menu entries are available.
      \param  point the position to which the context menu should be drawn
      \param  column not used at the moment
      \see    buildContextMenu
  */
  void showGuestContextMenu(const QPoint& pos);

  //_ called when a model is selected in the context menu
  void activatedItem_(QAction* action);

  //_
  void createRepresentation_();

  //
  void onItemClicked(QTreeWidgetItem* item, int);

  void changeRotamer_(int i);

  protected:

  void buildContextMenu_();

  void buildRotamerMenu_();

  void setSelection_(bool open, bool force = false);

  virtual MolecularInformation& getInformationVisitor_();
  
  virtual void recurseGeneration_(QTreeWidgetItem* item, Composite& composite);

  virtual bool reactToMessages_(Message* message);

  QTreeWidgetItem* generateListViewItem_(QTreeWidgetItem* parent,
                                          Composite& composite, QString* default_name = 0);

  //_ Test, if its allowed to paste the copy liste into the current selected context item.
  bool pasteAllowedFor_(Composite& composite);

  //
  inline void removeRecursive_(QTreeWidgetItem* item);

  // only for Python Interface
  MolecularControl(const MolecularControl& mc);

  //
  std::list<QTreeWidgetItem*> getAllItems_();

  void enableUpdates_(bool state);
  void newSelection_(std::list<Composite*>& sel, bool selected);

  bool allowPaste_();



  //_
  QAction* cut_id_, *copy_id_, *paste_id_, *delete_id_, *clipboard_id_, *select_id_, *deselect_id_,
      *show_ss_id_;


  std::list<Composite*>   selected_;
  std::list<Composite*>   copy_list_;

  MolecularInformation    information_;

  QComboBox*              selector_edit_;
  QComboBox*              smarts_edit_;

  // the context menus
  QMenu            context_menu_,
                   model_menu_,
                   edit_menu_,
                   color_menu_[MODEL_LABEL - MODEL_LINES];

  QMenu* rotamer_menu_;

  Composite*       context_composite_;

  QTreeWidgetItem* context_item_;

  ModelType        selected_model_;
  ColoringMethod   selected_coloring_method_;
  std::map<Composite*, MyTreeWidgetItem*> composite_to_item_;

  // let cut know to delete the entries, set by deleteCurrentItems()
  bool            was_delete_;

  Size            nr_items_removed_;

  bool            show_ss_;
  QAction* center_camera_action_, *composite_properties_action_, *bond_propertes_action_, *disulfidbond_action_,
           *select_action_, *deselect_action_, *count_items_action_, *atom_overview_, *atom_overview_selection_,
           *angle_action_, *distance_action_, *paste_action_;

  bool ignore_messages_;

  QSignalMapper* rotamer_mapper_;
  Residue* current_residue_;
  RotamerLibrary* rotamer_library_;
  ReadWriteLock rotamer_library_mutex_;
  QThread* rl_thread_;
};

}} // namespaces

#endif // BALL_VIEW_WIDGETS_MOLECULARCONTROL_H