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