finch/gntroomlist.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_ROOMLIST_H
  24 #define FINCH_ROOMLIST_H
  25
  26 /**
  27  * SECTION:gntroomlist
  28  * @section_id: finch-gntroomlist
  29  * @short_description: <filename>gntroomlist.h</filename>
  30  * @title: Room List API
  31  */
  32
  33 #include "roomlist.h"
  34
  35 /**********************************************************************
  36  * GNT Room List API
  37  **********************************************************************/
  38
  39 /**
  40  * finch_roomlist_init:
  41  *
  42  * Initialize the roomlist subsystem.
  43  */
  44 void finch_roomlist_init(void);
  45
  46 /**
  47  * finch_roomlist_get_ui_ops:
  48  *
  49  * Get the ui-functions.
  50  *
  51  * Returns: The PurpleRoomlistUiOps structure populated with the appropriate functions.
  52  */
  53 PurpleRoomlistUiOps *finch_roomlist_get_ui_ops(void);
  54
  55 /**
  56  * finch_roomlist_show_all:
  57  *
  58  * Show the roomlist dialog.
  59  */
  60 void finch_roomlist_show_all(void);
  61
  62 /**
  63  * finch_roomlist_uninit:
  64  *
  65  * Uninitialize the roomlist subsystem.
  66  */
  67 void finch_roomlist_uninit(void);
  68
  69 #endif /* FINCH_ROOMLIST_H */
  70