finch/gntpounce.h

   1 /*
   2  * finch
   3  *
   4  * Finch is the legal property of its developers, whose names are too numerous
   5  * to list here.  Please refer to the COPYRIGHT file distributed with this
   6  * source distribution.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  21  */
  22
  23 #ifndef FINCH_POUNCE_H
  24 #define FINCH_POUNCE_H
  25
  26 /**
  27  * SECTION:gntpounce
  28  * @section_id: finch-gntpounce
  29  * @short_description: <filename>gntpounce.h</filename>
  30  * @title: Buddy Pounce API
  31  */
  32
  33 #include "pounce.h"
  34
  35 /**
  36  * finch_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 finch_pounce_editor_show(PurpleAccount *account, const char *name,
  44                                                                 PurplePounce *cur_pounce);
  45
  46 /**
  47  * finch_pounces_manager_show:
  48  *
  49  * Shows the pounces manager window.
  50  */
  51 void finch_pounces_manager_show(void);
  52
  53 /**
  54  * finch_pounces_manager_hide:
  55  *
  56  * Hides the pounces manager window.
  57  */
  58 void finch_pounces_manager_hide(void);
  59
  60 /**
  61  * finch_pounces_get_handle:
  62  *
  63  * Returns the GNT pounces handle
  64  *
  65  * Returns: (transfer none): The handle to the GNT pounces system
  66  */
  67 void *finch_pounces_get_handle(void);
  68
  69 /**
  70  * finch_pounces_init:
  71  *
  72  * Initializes the GNT pounces subsystem.
  73  */
  74 void finch_pounces_init(void);
  75
  76 /**
  77  * finch_pounces_uninit:
  78  *
  79  * Uninitializes the GNT pounces subsystem.
  80  */
  81 void finch_pounces_uninit(void);
  82
  83 #endif /* FINCH_POUNCE_H */
  84