kopete/libkopete/ui/kopetecontactaction.h

   1 /*
   2     kopetecontactaction.cpp - KAction for selecting a Kopete::Contact
   3
   4     Copyright (c) 2003 by Martijn Klingens       <klingens@kde.org>
   5     Copyright (c) 2006 by Matt Rogers            <mattr@kde.org>
   6     Kopete    (c) 2003-2006 by the Kopete developers  <kopete-devel@kde.org>
   7
   8     *************************************************************************
   9     *                                                                       *
  10     * This library is free software; you can redistribute it and/or         *
  11     * modify it under the terms of the GNU Lesser General Public            *
  12     * License as published by the Free Software Foundation; either          *
  13     * version 2 of the License, or (at your option) any later version.      *
  14     *                                                                       *
  15     *************************************************************************
  16 */
  17
  18 #ifndef __kopetecontactaction_h__
  19 #define __kopetecontactaction_h__
  20
  21 #include <kaction.h>
  22 #include "kopete_export.h"
  23
  24 class KActionCollection;
  25 namespace Kopete
  26 {
  27 class Contact;
  28
  29 namespace UI
  30 {
  31
  32 /**
  33  * @author Martijn Klingens <klingens@kde.org>
  34  * @author Matt Rogers <mattr@kde.org>
  35  */
  36 class KOPETE_EXPORT ContactAction : public KAction
  37 {
  38         Q_OBJECT
  39 public:
  40         /**
  41          * Create a new KopeteContactAction
  42          *
  43          * The icon, text, and internal KAction name are taken from the
  44          * Kopete::Contact object given to this constructor
  45          *
  46          * @param contact the contact this action is for
  47          * @param parent the collection this action belongs to. The action is automatically added to the collection.
  48          *
  49          */
  50         ContactAction( Kopete::Contact *contact, KActionCollection* parent );
  51
  52 signals:
  53         /**
  54          * Emitted when the action is triggered. Connect to this slot when
  55          * you need to know which contact the action was triggered for
  56          */
  57         void triggered( Kopete::Contact*, bool checked );
  58
  59 private slots:
  60         /**
  61          * @internal
  62          * Reimplemented to emit triggered with a Kopete::Contact object
  63          */
  64         void slotTriggered( bool );
  65
  66 private:
  67         Kopete::Contact *m_contact;
  68 };
  69
  70 }
  71
  72 }
  73 #endif
  74 // vim: set noet ts=4 sts=4 sw=4:
  75 // kate: tab-width 4; auto-insert-doxygen on; indent-mode cstyle;
  76