chat/ml_chat_button.h

   1 /* Monolith chat button.
   2  * - by Richard W.M. Jones <rich@annexia.org>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the Free
  16  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  *
  18  * $Id: ml_chat_button.h,v 1.3 2003/02/22 15:34:28 rich Exp $
  19  */
  20
  21 #ifndef ML_CHAT_BUTTON_H
  22 #define ML_CHAT_BUTTON_H
  23
  24 #include <monolith.h>
  25 #include <ml_button.h>
  26
  27 /* Function: ml_chat_button - monolith chat button
  28  *
  29  * This is a wrapper around @code{new_ml_button} and
  30  * @code{ml_chat_window} which creates a "chat button". When pressed,
  31  * this button pops up a new window containing a chat window.
  32  *
  33  * @code{pool} is the pool for allocations. @code{session} is the
  34  * current session. @code{conninfo} is the database connection.
  35  * @code{resname} is the name of the chat room. @code{text} is the
  36  * text to display on the button.
  37  *
  38  * This returns an ordinary @code{ml_button} widget.
  39  *
  40  * See also: @ref{new_ml_button(3)}, @ref{ml_chat_window(3)}.
  41  */
  42 extern ml_button new_ml_chat_button (pool pool, ml_session session, const char *conninfo, const char *resname, const char *text);
  43
  44 #endif /* ML_CHAT_WINDOW_H */