finch/gntpounce.h

   1 /**
   2  * @file gntpounce.h GNT Buddy Pounce API
   3  * @ingroup finch
   4  */
   5
   6 /* finch
   7  *
   8  * Finch is the legal property of its developers, whose names are too numerous
   9  * to list here.  Please refer to the COPYRIGHT file distributed with this
  10  * source distribution.
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  25  */
  26 #ifndef _FINCHPOUNCE_H_
  27 #define _FINCHPOUNCE_H_
  28
  29 #include "pounce.h"
  30
  31 /**
  32  * Displays a New Buddy Pounce or Edit Buddy Pounce dialog.
  33  *
  34  * @param account    The optional account to use.
  35  * @param name       The optional name to pounce on.
  36  * @param cur_pounce The current buddy pounce, if editing an existing one.
  37  */
  38 void finch_pounce_editor_show(PurpleAccount *account, const char *name,
  39                                                                 PurplePounce *cur_pounce);
  40
  41 /**
  42  * Shows the pounces manager window.
  43  */
  44 void finch_pounces_manager_show(void);
  45
  46 /**
  47  * Hides the pounces manager window.
  48  */
  49 void finch_pounces_manager_hide(void);
  50
  51 /**
  52  * Returns the gtkpounces handle
  53  *
  54  * @return The handle to the GTK+ pounces system
  55  */
  56 void *finch_pounces_get_handle(void);
  57
  58 /**
  59  * Initializes the GNT pounces subsystem.
  60  */
  61 void finch_pounces_init(void);
  62
  63 /**
  64  * Uninitializes the GNT pounces subsystem.
  65  */
  66 void finch_pounces_uninit(void);
  67
  68 #endif /* _PURPLE_GTKPOUNCE_H_ */