pidgin/gtkpounce.h

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