workspace/libs/plasma/view.h

   1 /*
   2  *   Copyright 2007 Aaron Seigo <aseigo@kde.org>
   3  *
   4  *   This program is free software; you can redistribute it and/or modify
   5  *   it under the terms of the GNU Library General Public License as
   6  *   published by the Free Software Foundation; either version 2, or
   7  *   (at your option) any later version.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details
  13  *
  14  *   You should have received a copy of the GNU Library General Public
  15  *   License along with this program; if not, write to the
  16  *   Free Software Foundation, Inc.,
  17  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  */
  19
  20 #ifndef VIEW_H
  21 #define VIEW_H
  22
  23 #include <QtGui/QGraphicsView>
  24
  25 #include <plasma/plasma_export.h>
  26
  27 namespace Plasma
  28 {
  29
  30 class Containment;
  31 class Corona;
  32
  33 /**
  34  * @short A QGraphicsView for Plasma::Applets
  35  */
  36 class PLASMA_EXPORT View : public QGraphicsView
  37 {
  38     Q_OBJECT
  39
  40 public:
  41     View(int screen, Corona *corona, QWidget *parent = 0);
  42     explicit View(Containment *containment, QWidget *parent = 0);
  43     ~View();
  44
  45     /**
  46      * Sets whether or not to draw the containment wallpaper when painting
  47      * on this item
  48      */
  49     void setDrawWallpaper(bool draw);
  50
  51     /**
  52      * @return whether or not containments should draw wallpaper
  53      */
  54     bool drawWallpaper() const;
  55
  56     /**
  57      * Sets which screen this view is associated with, if any.
  58      * This will also set the containment if a valid screen is specified
  59      *
  60      * @arg screen the xinerama screen number; -1 for no screen
  61      */
  62     void setScreen(int screen);
  63
  64     /**
  65      * Returns the screen this view is associated with
  66      *
  67      * @return the xinerama screen number, or -1 for none
  68      */
  69     int screen() const;
  70
  71     /**
  72      * Sets which virtual desktop this view is asociated with, if any.
  73      *
  74      * @arg desktop a valid desktop number, -1 for all desktops, less than -1 for none
  75      */
  76     void setDesktop(int desktop);
  77
  78     /**
  79      * The virtual desktop this view is associated with
  80      *
  81      * @return the desktop number, -1 for all desktops and less than -1 for none
  82      */
  83     int desktop() const;
  84
  85     /**
  86      * The virtual desktop this view is actually being viewed on
  87      *
  88      * @return the desktop number (always valid, never < 0)
  89      */
  90     int effectiveDesktop() const;
  91
  92     /**
  93      * Sets the containment for this view, which will also cause the view
  94      * to track the geometry of the containment.
  95      *
  96      * @arg containment the containment to center the view on
  97      */
  98     void setContainment(Containment *containment);
  99
 100     /**
 101      * @return the containment associated with this view, or 0 if none is
 102      */
 103     Containment* containment() const;
 104
 105 protected Q_SLOTS:
 106     void updateSceneRect();
 107
 108 private:
 109     void initGraphicsView();
 110
 111     class Private;
 112     Private * const d;
 113 };
 114
 115 } // namespace Plasma
 116
 117 #endif
 118
 119