finch/gntroomlist.h

   1 /**
   2  * @file gntroomlist.h GNT Room List API
   3  * @ingroup finch
   4  */
   5
   6 /* finch
   7  *
   8  * Finch is the legal property of its developers, whose names are too numerous
   9  * to list here.  Please refer to the COPYRIGHT file distributed with this
  10  * source distribution.
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  25  */
  26 #ifndef _GNT_ROOMLIST_H
  27 #define _GNT_ROOMLIST_H
  28
  29 #include "roomlist.h"
  30
  31 /**********************************************************************
  32  * @name GNT Room List API
  33  **********************************************************************/
  34 /*@{*/
  35
  36 /**
  37  * Initialize the roomlist subsystem.
  38  */
  39 void finch_roomlist_init(void);
  40
  41 /**
  42  * Get the ui-functions.
  43  *
  44  * @return The PurpleRoomlistUiOps structure populated with the appropriate functions.
  45  */
  46 PurpleRoomlistUiOps *finch_roomlist_get_ui_ops(void);
  47
  48 /**
  49  * Show the roomlist dialog.
  50  */
  51 void finch_roomlist_show_all(void);
  52
  53 /**
  54  * Uninitialize the roomlist subsystem.
  55  */
  56 void finch_roomlist_uninit(void);
  57
  58 /*@}*/
  59
  60 #endif
  61