finch/gntconv.h

   1 /**
   2  * @file gntconv.h GNT Conversation API
   3  * @ingroup finch
   4  */
   5
   6 /* finch
   7  *
   8  * Finch 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 _GNT_CONV_H
  27 #define _GNT_CONV_H
  28
  29 #include <gnt.h>
  30 #include <gntwidget.h>
  31 #include <gntmenuitem.h>
  32
  33 #include "conversation.h"
  34
  35 /* Grabs the conv out of a PurpleConverstation */
  36 #define FINCH_CONV(conv) ((FinchConv *)(conv)->ui_data)
  37
  38 /***************************************************************************
  39  * @name GNT Conversations API
  40  ***************************************************************************/
  41 /*@{*/
  42
  43 typedef struct _FinchConv FinchConv;
  44 typedef struct _FinchConvChat FinchConvChat;
  45 typedef struct _FinchConvIm FinchConvIm;
  46
  47 typedef enum
  48 {
  49         FINCH_CONV_NO_SOUND     = 1 << 0,
  50 } FinchConversationFlag;
  51
  52 struct _FinchConv
  53 {
  54         GList *list;
  55         PurpleConversation *active_conv;
  56
  57         GntWidget *window;        /* the container */
  58         GntWidget *entry;         /* entry */
  59         GntWidget *tv;            /* text-view */
  60         GntWidget *menu;
  61         GntWidget *info;
  62         FinchConversationFlag flags;
  63
  64         union
  65         {
  66                 FinchConvChat *chat;
  67                 FinchConvIm *im;
  68         } u;
  69 };
  70
  71 struct _FinchConvChat
  72 {
  73         GntWidget *userlist;       /* the userlist */
  74         void *pad1;
  75         void *pad2;
  76 };
  77
  78 struct _FinchConvIm
  79 {
  80         GntMenuItem *sendto;
  81         void *something_for_later;
  82 };
  83
  84 /**
  85  * Get the ui-functions.
  86  *
  87  * @return The PurpleConversationUiOps populated with the appropriate functions.
  88  */
  89 PurpleConversationUiOps *finch_conv_get_ui_ops(void);
  90
  91 /**
  92  * Perform the necessary initializations.
  93  */
  94 void finch_conversation_init(void);
  95
  96 /**
  97  * Perform the necessary uninitializations.
  98  */
  99 void finch_conversation_uninit(void);
 100
 101 /**
 102  * Set a conversation as active in a contactized conversation
 103  *
 104  * @param conv The conversation to make active.
 105  */
 106 void finch_conversation_set_active(PurpleConversation *conv);
 107
 108 /**
 109  * Sets the information widget for the conversation window.
 110  *
 111  * @param conv   The conversation.
 112  * @param widget The widget containing the information. If @c NULL,
 113  *               the current information widget is removed.
 114  */
 115 void finch_conversation_set_info_widget(PurpleConversation *conv, GntWidget *widget);
 116
 117 /*@}*/
 118
 119 #endif