pidgin/gtkroomlist.h

   1 /* pidgin
   2  *
   3  * Pidgin 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 _PIDGINROOMLIST_H_
  23 #define _PIDGINROOMLIST_H_
  24 /**
  25  * SECTION:gtkroomlist
  26  * @section_id: pidgin-gtkroomlist
  27  * @short_description: <filename>gtkroomlist.h</filename>
  28  * @title: Room List UI
  29  */
  30
  31 #include "roomlist.h"
  32
  33 G_BEGIN_DECLS
  34
  35 /**
  36  * pidgin_roomlist_init:
  37  *
  38  * Initializes the room list subsystem.
  39  */
  40 void pidgin_roomlist_init(void);
  41
  42 /**
  43  * pidgin_roomlist_is_showable:
  44  *
  45  * Determines if showing the room list dialog is a valid action.
  46  *
  47  * Returns: TRUE if there are accounts online that support listing
  48  *         chat rooms.  Otherwise return FALSE.
  49  */
  50 gboolean pidgin_roomlist_is_showable(void);
  51
  52 /**
  53  * pidgin_roomlist_dialog_show:
  54  *
  55  * Shows a new roomlist dialog.
  56  */
  57 void pidgin_roomlist_dialog_show(void);
  58
  59 /**
  60  * pidgin_roomlist_dialog_show_with_account:
  61  * @account: The account to use.
  62  *
  63  * Shows a new room list dialog and fetches the list for the specified account.
  64  */
  65 void pidgin_roomlist_dialog_show_with_account(PurpleAccount *account);
  66
  67 G_END_DECLS
  68
  69 #endif /* _PIDGINROOMLIST_H_ */