kopete/libkopete/ui/kopeteviewplugin.h

   1 /*
   2     kopeteviewplugin.h - View Manager
   3
   4     Copyright (c) 2005      by Jason Keirstead       <jason@keirstead.org>
   5     Kopete    (c) 2002-2005 by the Kopete developers <kopete-devel@kde.org>
   6
   7     *************************************************************************
   8     *                                                                       *
   9     * This library is free software; you can redistribute it and/or         *
  10     * modify it under the terms of the GNU Lesser General Public            *
  11     * License as published by the Free Software Foundation; either          *
  12     * version 2 of the License, or (at your option) any later version.      *
  13     *                                                                       *
  14     *************************************************************************
  15 */
  16
  17 #ifndef KOPETEVIEWPLUGIN_H
  18 #define KOPETEVIEWPLUGIN_H
  19
  20 #include "kopeteplugin.h"
  21
  22 class KopeteView;
  23
  24 namespace Kopete
  25 {
  26
  27 class ChatSession;
  28
  29 /**
  30  * @author Jason Keirstead
  31  *
  32  * @brief Factory plugin for creating KopeteView objects.
  33  *
  34  * Kopete ships with two of these currently, a Chat Window view plugin, and
  35  * an Email Window view plugin.
  36  *
  37  */
  38 class KOPETE_EXPORT ViewPlugin : public Plugin
  39 {
  40         public:
  41                 /**
  42                  * @brief Create and initialize the plugin
  43                  */
  44                 explicit ViewPlugin( const KComponentData &instance, QObject *parent = 0L );
  45
  46                 /**
  47                  * @brief Creates a view to be associated with the passed in session
  48                 */
  49                 virtual KopeteView *createView( ChatSession * /*session*/ ){ return 0L; }
  50
  51                 /**
  52                  * @brief Reimplemented from Kopete::Plugin
  53                  */
  54                 virtual void aboutToUnload();
  55 };
  56
  57 }
  58
  59 #endif