finch/gntpounce.h

   1 /* finch
   2  *
   3  * Finch 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 _FINCHPOUNCE_H_
  23 #define _FINCHPOUNCE_H_
  24 /**
  25  * SECTION:gntpounce
  26  * @section_id: finch-gntpounce
  27  * @short_description: <filename>gntpounce.h</filename>
  28  * @title: Buddy Pounce API
  29  */
  30
  31 #include "pounce.h"
  32
  33 /**
  34  * finch_pounce_editor_show:
  35  * @account:    The optional account to use.
  36  * @name:       The optional name to pounce on.
  37  * @cur_pounce: The current buddy pounce, if editing an existing one.
  38  *
  39  * Displays a New Buddy Pounce or Edit Buddy Pounce dialog.
  40  */
  41 void finch_pounce_editor_show(PurpleAccount *account, const char *name,
  42                                                                 PurplePounce *cur_pounce);
  43
  44 /**
  45  * finch_pounces_manager_show:
  46  *
  47  * Shows the pounces manager window.
  48  */
  49 void finch_pounces_manager_show(void);
  50
  51 /**
  52  * finch_pounces_manager_hide:
  53  *
  54  * Hides the pounces manager window.
  55  */
  56 void finch_pounces_manager_hide(void);
  57
  58 /**
  59  * finch_pounces_get_handle:
  60  *
  61  * Returns the GNT pounces handle
  62  *
  63  * Returns: (transfer none): The handle to the GNT pounces system
  64  */
  65 void *finch_pounces_get_handle(void);
  66
  67 /**
  68  * finch_pounces_init:
  69  *
  70  * Initializes the GNT pounces subsystem.
  71  */
  72 void finch_pounces_init(void);
  73
  74 /**
  75  * finch_pounces_uninit:
  76  *
  77  * Uninitializes the GNT pounces subsystem.
  78  */
  79 void finch_pounces_uninit(void);
  80
  81 #endif /* _PURPLE_FINCHPOUNCE_H_ */