annotate gtk/gtkroomlist.h @ 14559:fe9222bf8b1d

[gaim-migrate @ 17282] Sometimes the order in which things happen is quite important. In this case the chicken quite definitely came before the egg. Also make the libxml2 check explicit to what minimum version we need. committer: Tailor Script <[e-mail]>

/**
 * @file gtkroomlist.h GTK+ Room List UI
 * @ingroup gtkui
 *
 * gaim
 *
 * Gaim is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef _GAIM_GTKROOMLIST_H_
#define _GAIM_GTKROOMLIST_H_

#include "roomlist.h"


typedef struct _GaimGtkRoomlistDialog GaimGtkRoomlistDialog;

/**
 * Initializes the room list subsystem.
 */
void gaim_gtk_roomlist_init(void);

/**
 * Determines if showing the room list dialog is a valid action.
 *
 * @return TRUE if there are accounts online that support listing
 *         chat rooms.  Otherwise return FALSE.
 */
gboolean gaim_gtk_roomlist_is_showable(void);

/**
 * Shows the roomlist dialog.
 */
void gaim_gtk_roomlist_dialog_show(void);

/**
 * Creates a new room list dialog.
 *
 * @return The new dialog.
 */
GaimGtkRoomlistDialog *gaim_gtk_roomlist_dialog_new(void);

/**
 * Creates a new room list dialog and fetch the list on
 * the specified account.
 *
 * @param account The account to force.
 * @return The new dialog.
 */
GaimGtkRoomlistDialog *gaim_gtk_roomlist_dialog_new_with_account(GaimAccount *account);

#endif /* _GAIM_GTKROOMLIST_H_ */