kalzium/src/periodictableview.h

   1 /***************************************************************************
   2  *   Copyright (C) 2003-2007 by Carsten Niehaus                            *
   3  *   cniehaus@kde.org                                                      *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef PeriodicTableView_H
  22 #define PeriodicTableView_H
  23
  24 class Element;
  25 class KalziumPainter;
  26 class KalziumGradientType;
  27
  28 #include <QTimer>
  29 #include <QWidget>
  30 #include <QPoint>
  31 #include <QPixmap>
  32 #include <QMap>
  33
  34 #include "kalziumpainter.h"
  35
  36 #include <chemicaldataobject.h>
  37
  38 /**
  39  * A PeriodicTableView is the widget on which we paint a periodic table.
  40  *
  41  * It does not contain any code for painting, as all the painting routines
  42  * belongs to KalziumPainter.
  43  *
  44  * @author Carsten Niehaus
  45  * @author Pino Toscano
  46  */
  47 class PeriodicTableView : public QWidget
  48 {
  49         Q_OBJECT
  50
  51         public:
  52                 /**
  53                  * Constructor
  54                  * @param parent parent widget
  55                  */
  56                 PeriodicTableView( QWidget *parent = 0 );
  57                 ~PeriodicTableView();
  58
  59                 /**
  60                  * Draw the full table next time
  61                  */
  62                 void setFullDraw();
  63
  64                 /**
  65                  * Sets the numeration type to the one with index @p which.
  66                  */
  67                 void setNumeration( int which );
  68
  69                 /**
  70                  * put the limit for the @p type specified, but do not actually (de)activate it
  71                  * @param type type of the @p value
  72                  * @param value the value of the the limit for @p type
  73                  */
  74                 void setValueLimit( int value, ChemicalDataObject::BlueObelisk type );
  75
  76         /**
  77         * Generate a SVG from the current table and save it in the file @p filename
  78         */
  79         void generateSvg(const QString& filename);
  80
  81                 /**
  82                  * Sets the scheme to use.
  83                  * @param nr is the index of the new scheme
  84                  */
  85                 void activateColorScheme( const int nr);
  86
  87                 /**
  88                  * @return the KalziumSchemeType of the current view
  89                  */
  90                 KalziumSchemeType* scheme() const;
  91
  92                 /**
  93                  * @return the short and descriptive name of this PeriodicTableView
  94                  */
  95                 QString shortName() const{
  96                         return m_ShortName;
  97                 }
  98
  99                 /**
 100                  * @return the current gradient type
 101                  */
 102                 KalziumGradientType* gradient() const;
 103
 104                 /**
 105                  * sets te KalziumGradientType
 106                  */
 107                 void setGradient( int which );
 108
 109                 void setMode( KalziumPainter::MODE m );
 110
 111                 /**
 112                  * @return the current KalziumPainter::MODE
 113                  */
 114                 KalziumPainter::MODE mode() const;
 115
 116                 /**
 117                  * @param type the type of value which is searched for
 118                  * @return the value of the @p type
 119                  */
 120                 int sliderValue( ChemicalDataObject::BlueObelisk type );
 121
 122                 /**
 123                  * @return the QBrush for the Element @p element
 124                  */
 125                 QBrush brushForElement( int element ) const;
 126
 127                 KalziumTableType* tableType() const;
 128
 129         private:
 130                 QMap <ChemicalDataObject::BlueObelisk, int> m_sliderValueList;
 131
 132                 /**
 133                  * the currently selected element
 134                  */
 135                 int m_currentElement;
 136
 137                 /**
 138                  * this is a short, descriptive name of the PeriodicTableView
 139                  */
 140                 QString m_ShortName;
 141
 142                 /**
 143                  * implements double buffering of the widget.
 144                  */
 145                 QPixmap *table;                 // The basic PeriodicTableView
 146                 QPixmap *table2;                // Basic PeriodicTableView + extra data such as tooltip, etc
 147
 148                 /**
 149                  * used for bitBlit. If true the complete table will be drawn
 150                  */
 151                 bool doFullDraw;
 152
 153                 KalziumPainter *m_painter;
 154
 155                 QPoint m_startDrag;
 156
 157                 /**
 158                  * Used to delay the emit of MouseOver().
 159                  */
 160                 QTimer m_hoverTimer;
 161                 int m_prevHoverElement;
 162
 163         protected:
 164                 virtual void paintEvent( QPaintEvent *e );
 165                 virtual void mouseReleaseEvent( QMouseEvent* );
 166                 virtual void mousePressEvent( QMouseEvent* event );
 167                 virtual void mouseMoveEvent( QMouseEvent* );
 168
 169         public slots:
 170                 /**
 171                  * This method sets the color for the buttons corresponding to
 172                  * the given temperature @p temp
 173                  * @param temp is the temperature to which all buttons will be set
 174                  */
 175                 void setTemperature( int temp );
 176
 177         void setTime( int time );
 178
 179         void slotChangeTable( int table );
 180
 181                 /**
 182                  * this slot removes the selection of any point
 183                  */
 184                 void unSelect();
 185
 186         private slots:
 187                 /**
 188                  * If called this slot will emit the signal MouseOver( num )
 189                  * where num is the number of the element the mouse if over.
 190                  * If the mouse is not over an element nothing will be emitted
 191                  * @see MouseOver()
 192                  */
 193                 void slotMouseover();
 194
 195                 /**
 196                  * this slot updates the currently selected point
 197                  */
 198                 void selectPoint( const QPoint& point );
 199
 200                 /**
 201                  * this slot updates the element given in the @p num
 202                  * @param num The number of the selected element
 203                  */
 204                 void selectElement( int num );
 205
 206         signals:
 207                 /**
 208                  * this signal is emitted when an element is clicked
 209                  */
 210                 void ElementClicked(int);
 211
 212                 /**
 213                  * This signal is emitted when the mouse pointer is
 214                  * over an element
 215                  */
 216                 void MouseOver( int );
 217
 218         void ModeChanged( KalziumPainter::MODE );
 219
 220         void TableTypeChanged( KalziumTableType * );
 221
 222         void GradientTypeChanged( KalziumGradientType * );
 223
 224         void SchemeChanged( KalziumSchemeType * );
 225 };
 226
 227
 228 #endif