pidgin/gtkroomlist.h

   1 /**
   2  * @file gtkroomlist.h GTK+ Room List UI
   3  * @ingroup pidgin
   4  */
   5
   6 /* pidgin
   7  *
   8  * Pidgin 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 _PIDGINROOMLIST_H_
  27 #define _PIDGINROOMLIST_H_
  28
  29 #include "roomlist.h"
  30
  31 /**
  32  * Initializes the room list subsystem.
  33  */
  34 void pidgin_roomlist_init(void);
  35
  36 /**
  37  * Determines if showing the room list dialog is a valid action.
  38  *
  39  * @return TRUE if there are accounts online that support listing
  40  *         chat rooms.  Otherwise return FALSE.
  41  */
  42 gboolean pidgin_roomlist_is_showable(void);
  43
  44 /**
  45  * Shows a new roomlist dialog.
  46  */
  47 void pidgin_roomlist_dialog_show(void);
  48
  49 /**
  50  * Shows a new room list dialog and fetches the list for the specified account.
  51  *
  52  * @param account The account to use.
  53  */
  54 void pidgin_roomlist_dialog_show_with_account(PurpleAccount *account);
  55
  56 #endif /* _PIDGINROOMLIST_H_ */