Warning, file /office/calligra/libs/flake/KoCanvasObserverBase.h was not indexed or was modified since last indexation (in which case cross-reference links may be missing, inaccurate or erroneous).

0001 /* This file is part of the KDE project
0002  * Copyright (C) 2007 Thomas Zander <zander@kde.org>
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Library General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2 of the License, or (at your option) any later version.
0008  *
0009  * This library is distributed in the hope that it will be useful,
0010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012  * Library General Public License for more details.
0013  *
0014  * You should have received a copy of the GNU Library General Public License
0015  * along with this library; see the file COPYING.LIB.  If not, write to
0016  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0017  * Boston, MA 02110-1301, USA.
0018  */
0019 
0020 #ifndef KOCANVASOBSERVERBASE_H
0021 #define KOCANVASOBSERVERBASE_H
0022 
0023 class KoCanvasBase;
0024 class KoCanvasObserverBasePrivate;
0025 
0026 #include "flake_export.h"
0027 
0028 class QString;
0029 
0030 /**
0031  * An abstract canvas observer interface class.
0032  * Dockers that want to be notified of active canvas changes
0033  * should implement that interface so that the tool controller
0034  * can give them the active canvas.
0035  */
0036 class FLAKE_EXPORT KoCanvasObserverBase
0037 {
0038 public:
0039     KoCanvasObserverBase();
0040     virtual ~KoCanvasObserverBase();
0041 
0042     virtual QString observerName() const;
0043 
0044     /**
0045      * set observed canvas
0046      * @param canvas canvas to observe. Can be 0.
0047      */
0048     void setObservedCanvas(KoCanvasBase *canvas);
0049 
0050     /**
0051      * notify the observer that canvas is gone
0052      */
0053     void unsetObservedCanvas();
0054 
0055     /**
0056      * the currently observed canvas
0057      * @return observed canvas, can be 0
0058      */
0059     KoCanvasBase* observedCanvas() const;
0060 
0061 protected:
0062     /**
0063      * re-implement this method in your canvas observer. It will be called
0064      * whenever a canvas becomes active. Note that you are responsible for
0065      * not connecting more than one time to the signals of a canvas or any
0066      * of the QObjects you can access through the canvas.
0067      */
0068     virtual void setCanvas(KoCanvasBase *canvas) = 0;
0069 
0070     /**
0071      * re-implement to notify the observer that its canvas is no longer
0072      * among the living. The daisies, it is pushing up. This means you
0073      * don't have to unconnect, it's dead.
0074      * Note that currently there is a bug where in certain specific
0075      * circumstances unsetCanvas can be called when it shouldn't, see for
0076      * example KWStatisticsDocker for a workaround for this problem.
0077      */
0078     virtual void unsetCanvas() = 0;
0079 
0080 private:
0081     KoCanvasObserverBasePrivate * const d;
0082 };
0083 
0084 #endif // KOCANVASOBSERVERBASE_H