sublime/mainwindowoperator.h

   1 /***************************************************************************
   2  *   Copyright 2006-2007 Alexander Dymo  <adymo@kdevelop.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 of the    *
   7  *   License, or (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 #ifndef SUBLIMEMAINWINDOWOPERATOR_H
  20 #define SUBLIMEMAINWINDOWOPERATOR_H
  21
  22 //krazy:excludeall=dpointer
  23
  24 #include "sublimeexport.h"
  25
  26 #include <QIcon>
  27
  28 namespace Sublime {
  29
  30 class Area;
  31 class View;
  32 class MainWindow;
  33
  34 /**Proxy class to give descendants access to MainWindow::setArea
  35 and MainWindow::hideArea methods. Just inherit it and use the methods.*/
  36 class SUBLIME_EXPORT MainWindowOperator {
  37 protected:
  38     /**Sets the area of main window and fills it with views.*/
  39     void setArea(MainWindow *w, Area *area);
  40     /**Unsets the area clearing main window.*/
  41     void clearArea(MainWindow *w);
  42
  43     /**Sets the active view for the mainwindow and focuses it.*/
  44     void setActiveView(MainWindow *w, View *view);
  45     /**Sets the active toolview for the mainwindow and focuses it.*/
  46     void setActiveToolView(MainWindow *w, View *view);
  47
  48     /**Sets the status icon for the given \a view in the \a mainWindow to \a icon.*/
  49     void setStatusIcon(MainWindow* w, View* view, const QIcon& icon);
  50 };
  51
  52 }
  53
  54 #endif
  55