kmag/kmag.h

   1 /***************************************************************************
   2                           kmag.h  -  description
   3                              -------------------
   4     begin                : Mon Feb 12 23:45:41 EST 2001
   5     copyright            : (C) 2001 by Sarang Lakare
   6     email                : sarang@users.sourceforge.net
   7     copyright            : (C) 2003-2004 by Olaf Schmidt
   8     email                : ojschmidt@kde.org
   9     copyright            : (C) 2008 by Matthew Woehlke
  10     email                : mw_triad@users.sourceforge.net
  11  ***************************************************************************/
  12
  13 /***************************************************************************
  14  *                                                                         *
  15  *   This program is free software; you can redistribute it and/or modify  *
  16  *   it under the terms of the GNU General Public License as published by  *
  17  *   the Free Software Foundation; either version 2 of the License, or     *
  18  *   (at your option) any later version.                                   *
  19  *                                                                         *
  20  ***************************************************************************/
  21
  22
  23 #ifndef KMAG_H
  24 #define KMAG_H
  25
  26 #include "kmagzoomview.h"
  27
  28 #include <vector>
  29
  30 // include files for Qt
  31 #include <QtGui/QContextMenuEvent>
  32
  33 // include files for KDE
  34 #include <kxmlguiwindow.h>
  35 #include <k3dockwidget.h>
  36 #include <kaction.h>
  37 #include <knuminput.h>
  38 #include <kconfig.h>
  39
  40 /**
  41   * The base class for Kmag application windows. It sets up the main
  42   * window and reads the config file as well as providing a menubar, toolbar
  43   * and statusbar. An instance of KmagView creates your center view, which is connected
  44   * to the window's Doc object.
  45   * KmagApp reimplements the methods that KXmlGuiWindow provides for main window handling and supports
  46   * full session management as well as using KActions.
  47   * @see KXmlGuiWindow
  48   * @see KApplication
  49   * @see KConfig
  50   *
  51   * @author Source Framework Automatically Generated by KDevelop, (c) The KDevelop Team.
  52   * @version KDevelop version 1.2 code generation
  53   */
  54 class KmagApp : public KXmlGuiWindow
  55 {
  56   Q_OBJECT
  57
  58   public:
  59     /**
  60      * Construtor of KmagApp, calls all init functions to create the application.
  61      */
  62     explicit KmagApp(QWidget* parent=0, const char* name=0);
  63
  64     /// Default destructor
  65     ~KmagApp();
  66
  67
  68
  69   protected:
  70     /** save general Options like all bar positions and status as well as the geometry and the recent file list to the configuration
  71      * file
  72      */
  73     void saveOptions();
  74     /** read general Options again and initialize all variables like the recent file list
  75      */
  76     void readOptions();
  77     /** initializes the KActions of the application */
  78     void initActions();
  79
  80     /** creates the centerwidget of the KTMainWindow instance and sets it as the view
  81      */
  82     void initView();
  83
  84     /// Initialize all connections
  85     void initConnections();
  86
  87     virtual bool queryClose();
  88
  89     /** queryExit is called by KTMainWindow when the last window of the application is going to be closed during the closeEvent().
  90      * Against the default implementation that just returns true, this calls saveOptions() to save the settings of the last window's
  91      * properties.
  92      * @see KTMainWindow#queryExit
  93      * @see KTMainWindow#closeEvent
  94      */
  95     virtual bool queryExit();
  96
  97     /// Catch context menu events
  98     void contextMenuEvent ( QContextMenuEvent * e );
  99
 100   public slots:
 101     /** open a new application window by creating a new instance of KmagApp */
 102     void slotFileNewWindow();
 103
 104     /** print the actual file */
 105     void slotFilePrint();
 106
 107     void slotFileQuit();
 108
 109     /** put the marked text/object into the clipboard
 110      */
 111     void copyToClipBoard();
 112
 113     /// Toggle the refreshing of the window
 114     void slotToggleRefresh();
 115
 116     void slotModeFollowMouse();
 117     void slotModeWholeScreen();
 118     void slotModeSelWin();
 119
 120     /// Zooms in
 121     void zoomIn();
 122
 123     /// Zooms out
 124     void zoomOut();
 125
 126     /// Save the zoomed image
 127     void saveZoomPixmap();
 128
 129     /// Sets the zoom index to index
 130     void setZoomIndex(int index);
 131
 132     /// Sets the rotation index to index
 133     void setRotationIndex(int index);
 134
 135     /// Sets the fps index to index
 136     void setFPSIndex(int index);
 137
 138     /// Sets the color index to index
 139     void setColorIndex(int index);
 140
 141     /// Shows/hides the mouse cursor
 142     void showMouseCursor(bool show);
 143
 144     void slotShowMenu();
 145     void slotShowMainToolBar();
 146     void slotShowViewToolBar();
 147     void slotShowSettingsToolBar();
 148
 149     void slotToggleHideCursor();
 150
 151     /// Opens shortcut key configuration dialog
 152     void slotConfKeys();
 153
 154     /// Called when toolbar config is updated
 155     void slotNewToolbarConfig();
 156
 157     /// Called when "configure toolbar" is clicked
 158     void slotEditToolbars();
 159
 160     void slotChangeZoomBoxIndex(int index);
 161     void slotChangeRotationBoxIndex(int index);
 162     void slotChangeFPSIndex(int index);
 163     void slotChangeColorIndex(int index);
 164
 165
 166   signals:
 167     /// This signal is raised whenever the index into the zoom array is changed
 168     void updateZoomIndex(int);
 169
 170     /// This signal is raised whenever the zoom value changes
 171     void updateZoomValue(float);
 172
 173     /// This signal is raised whenever the index into the rotation array is changed
 174     void updateRotationIndex(int);
 175
 176     /// This signal is raised whenever the rotation value changes
 177     void updateRotationValue(int);
 178
 179     /// This signal is raised whenever the index into the fps array is changed
 180     void updateFPSIndex(int);
 181
 182     /// This signal is raised whenever the fps value changes
 183     void updateFPSValue(float);
 184
 185     /// This signal is raised whenever the index into the color array is changed
 186     void updateColorIndex(int);
 187
 188     /// This signal is raised whenever the color value changes
 189     void updateColorValue(int);
 190
 191   private:
 192     /// the configuration object of the application
 193     KSharedConfigPtr config;
 194
 195     // KAction pointers to enable/disable actions
 196     QAction *fileNewWindow, *m_pSnapshot, *m_pCopy, *m_keyConf, *m_toolConf;
 197     QAction *m_pPrint;
 198     QAction *m_pZoomIn;
 199     QAction *m_pZoomOut;
 200     QAction *m_pQuit;
 201     QAction *refreshSwitch;
 202     KToggleAction *m_pShowMenu, *m_pShowMainToolBar, *m_pShowViewToolBar, *m_pShowSettingsToolBar;
 203     KSelectAction *m_pZoomBox, *m_pRotationBox, *m_pFPSBox, *m_pColorBox;
 204
 205     /// zoom slider
 206     KIntNumInput *m_zoomSlider;
 207
 208     /// Current index into the zoomArray
 209     unsigned int m_zoomIndex;
 210
 211     /// Current index into the rotationArray
 212     unsigned int m_rotationIndex;
 213
 214     /// Current index into the fpsArray
 215     unsigned int m_fpsIndex;
 216
 217     /// Current index into the colorArray
 218     unsigned int m_colorIndex;
 219
 220     QStringList zoomArrayString;
 221     std::vector<float> zoomArray;
 222
 223     QStringList rotationArrayString;
 224     std::vector<int> rotationArray;
 225
 226     QStringList fpsArrayString;
 227     std::vector<float> fpsArray;
 228
 229     QStringList colorArrayString;
 230     std::vector<int> colorArray;
 231
 232   KMagZoomView* m_zoomView;
 233   KToggleAction *m_hideCursor;
 234   KToggleAction *m_modeFollowMouse, *m_modeWholeScreen, *m_modeSelWin;
 235
 236   /// Stores the non-zero cursor type to be used
 237   unsigned int m_mouseCursorType;
 238
 239   unsigned int m_defaultMouseCursorType;
 240 };
 241
 242
 243 #endif // KMAG_H