discussion/ml_discussion_panel.h

   1 /* Monolith discussion panel widget.
   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_discussion_panel.h,v 1.3 2003/02/22 15:34:29 rich Exp $
  19  */
  20
  21 #ifndef ML_DISCUSSION_PANEL_H
  22 #define ML_DISCUSSION_PANEL_H
  23
  24 #include <monolith.h>
  25
  26 struct ml_discussion_panel;
  27 typedef struct ml_discussion_panel *ml_discussion_panel;
  28
  29 /* Function: new_ml_discussion_panel - monolith discussion panel widget
  30  *
  31  * The @code{ml_discussion_panel} widget displays a list of available
  32  * newsgroups on the left, and a particular selected newsgroup on the
  33  * right. Users can select which newsgroup to view by clicking one of
  34  * the available groups on the left.
  35  *
  36  * The actual newsgroup is displayed using the @code{ml_discussion}
  37  * widget (see @ref{new_ml_discussion(3)}.
  38  *
  39  * The overall layout is achieved using the @code{ml_select_layout}
  40  * layout widget (see @ref{new_ml_select_layout(3)}.
  41  *
  42  * @code{new_ml_discussion_panel} creates a new discussion panel
  43  * widget.  The pool for allocations, current session and database
  44  * handle factory must be given. This function returns the panel
  45  * widget, or @code{NULL} if it could not be created.
  46  *
  47  * See also: @ref{new_ml_discussion(3)}, @ref{new_ml_select_layout(3)}.
  48  */
  49 extern ml_discussion_panel new_ml_discussion_panel (pool, ml_session, const char *conninfo);
  50
  51 #endif /* ML_DISCUSSION_PANEL_H */