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