5032
|
1 /**
|
|
2 * @file gtkpounce.h GTK+ buddy pounce API
|
|
3 *
|
|
4 * gaim
|
|
5 *
|
|
6 * Copyright (C) 2003, Christian Hammond <chipx86@gnupdate.org>
|
|
7 *
|
|
8 * This program is free software; you can redistribute it and/or modify
|
|
9 * it under the terms of the GNU General Public License as published by
|
|
10 * the Free Software Foundation; either version 2 of the License, or
|
|
11 * (at your option) any later version.
|
|
12 *
|
|
13 * This program is distributed in the hope that it will be useful,
|
|
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
16 * GNU General Public License for more details.
|
|
17 *
|
|
18 * You should have received a copy of the GNU General Public License
|
|
19 * along with this program; if not, write to the Free Software
|
|
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
21 *
|
|
22 */
|
|
23 #ifndef _GAIM_GTK_POUNCE_H_
|
|
24 #define _GAIM_GTK_POUNCE_H_
|
|
25
|
|
26 #include "pounce.h"
|
|
27
|
|
28 /**
|
|
29 * Types of actions that gaim's GTK+ interface supports.
|
|
30 */
|
|
31 typedef enum
|
|
32 {
|
|
33 GAIM_GTKPOUNCE_NONE = 0x00, /**< No action. */
|
|
34 GAIM_GTKPOUNCE_OPEN_WIN = 0x01, /**< Open an IM window. */
|
|
35 GAIM_GTKPOUNCE_POPUP = 0x02, /**< Popup notification. */
|
|
36 GAIM_GTKPOUNCE_SEND_MSG = 0x04, /**< Send a message. */
|
|
37 GAIM_GTKPOUNCE_EXEC_CMD = 0x08, /**< Execute a command. */
|
|
38 GAIM_GTKPOUNCE_PLAY_SOUND = 0x10 /**< Play a sound. */
|
|
39
|
|
40 } GaimGtkPounceAction;
|
|
41
|
|
42 /**
|
|
43 * GTK+ pounce-specific data.
|
|
44 */
|
|
45 struct gaim_gtkpounce_data
|
|
46 {
|
|
47 GaimGtkPounceAction actions; /**< The action(s) for this pounce. */
|
|
48
|
|
49 char *message; /**< The message to send, if
|
|
50 GAIM_GTKPOUNCE_SEND_MSG is in actions. */
|
|
51 char *command; /**< The command to execute, if
|
|
52 GAIM_GTKPOUNCE_EXEC_CMD is in actions. */
|
|
53 char *sound; /**< The sound file to play, if
|
|
54 GAIM_GTKPOUNCE_PLAY_SOUND is in actions. */
|
|
55
|
|
56 gboolean save; /**< If TRUE, the pounce should be saved after
|
|
57 activation. */
|
|
58 };
|
|
59
|
|
60 #define GAIM_GTKPOUNCE(pounce) \
|
|
61 ((struct gaim_gtkpounce_data *)gaim_pounce_get_data(pounce))
|
|
62
|
|
63 /**
|
|
64 * The pounce dialog.
|
|
65 *
|
|
66 * The structure is opaque, as nobody should be touching anything inside of
|
|
67 * it.
|
|
68 */
|
|
69 struct gaim_gtkpounce_dialog;
|
|
70
|
|
71 /**
|
|
72 * Creates a GTK-specific pounce.
|
|
73 *
|
|
74 * @param pouncer The account that will pounce.
|
|
75 * @param pouncee The buddy to pounce on.
|
|
76 * @param events The event(s) to pounce on.
|
|
77 * @param actions The actions.
|
|
78 * @param message The optional message to send.
|
|
79 * @param command The optional command to execute.
|
|
80 * @param sound The optional sound to play.
|
|
81 * @param save Whether or not to save the data.
|
|
82 *
|
|
83 * @return The new buddy pounce.
|
|
84 */
|
|
85 struct gaim_pounce *gaim_gtkpounce_new(struct gaim_account *pouncer,
|
|
86 const char *pouncee,
|
|
87 GaimPounceEvent events,
|
|
88 GaimGtkPounceAction actions,
|
|
89 const char *message,
|
|
90 const char *command,
|
|
91 const char *sound,
|
|
92 gboolean save);
|
|
93
|
|
94 /**
|
|
95 * Displays a New Buddy Pounce or Edit Buddy Pounce dialog.
|
|
96 *
|
|
97 * @param buddy The optional buddy to pounce on.
|
|
98 * @param cur_pounce The current buddy pounce, if editting an existing one.
|
|
99 */
|
|
100 void gaim_gtkpounce_dialog_show(struct buddy *buddy,
|
|
101 struct gaim_pounce *cur_pounce);
|
|
102
|
|
103 /**
|
|
104 * Displays all registered buddy pounces in a menu.
|
|
105 *
|
|
106 * @param menu The menu to add to.
|
|
107 */
|
|
108 void gaim_gtkpounce_menu_build(GtkWidget *menu);
|
|
109
|
|
110 #endif /* _GAIM_GTK_POUNCE_H_ */
|