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