/* Monolith chat window.
 * - by Richard W.M. Jones <rich@annexia.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * $Id: ml_chat_window.h,v 1.3 2003/02/22 15:34:28 rich Exp $
 */

#ifndef ML_CHAT_WINDOW_H
#define ML_CHAT_WINDOW_H

#include <monolith.h>

/* Function: ml_chat_window - monolith chat window
 *
 * This is the monolith chat window. The chat window displays the
 * contents of one chat room in an ordinary browser without requiring
 * anything beyond HTML and some very simple Javascript.
 *
 * Chat isn't a normal widget because it makes complex use of frames.
 *
 * @code{ml_chat_window} creates a new frameset. You would normally
 * set this function as a callback function from a popup button
 * (see @code{new_ml_button(3)}, @code{ml_button_set_popup(3)},
 * @code{ml_button_set_callback(3)}).
 *
 * @code{ml_chat_window_args} must be a pointer to a
 * @code{struct ml_chat_window_args}. This structure has the following
 * required fields:
 *
 * @code{conninfo}: The database connection.
 *
 * @code{resname}: The name of the chat room (in the @code{ml_resources}
 * database table).
 *
 * See also: @ref{new_ml_chat_button(3)}.
 */
extern void ml_chat_window (ml_session, void *ml_chat_window_args);

/* You must pass a pointer to this structure as the second argument
 * to ml_chat_window.
 */
struct ml_chat_window_args
{
  const char *conninfo;		/* Database connection. */
  const char *resname;		/* Chat room name. */
};

#endif /* ML_CHAT_WINDOW_H */