Tue, 04 Feb 2014 01:36:57 +0530
Merge gtkdoc-conversion
| 11475 | 1 | /** |
| 15577 | 2 | * @file gtkwhiteboard.h The PidginWhiteboard frontend object |
|
20147
66f05a854eee
applied changes from 8a731bbd0197fbcc91a705c2d8f528154216defa
Richard Laager <rlaager@pidgin.im>
parents:
19859
diff
changeset
|
3 | */ |
|
66f05a854eee
applied changes from 8a731bbd0197fbcc91a705c2d8f528154216defa
Richard Laager <rlaager@pidgin.im>
parents:
19859
diff
changeset
|
4 | |
|
66f05a854eee
applied changes from 8a731bbd0197fbcc91a705c2d8f528154216defa
Richard Laager <rlaager@pidgin.im>
parents:
19859
diff
changeset
|
5 | /* pidgin |
| 11475 | 6 | * |
| 15572 | 7 | * Pidgin is the legal property of its developers, whose names are too numerous |
| 11475 | 8 | * to list here. Please refer to the COPYRIGHT file distributed with this |
| 9 | * source distribution. | |
| 10 | * | |
| 11 | * This program is free software; you can redistribute it and/or modify | |
| 12 | * it under the terms of the GNU General Public License as published by | |
| 13 | * the Free Software Foundation; either version 2 of the License, or | |
| 14 | * (at your option) any later version. | |
| 15 | * | |
| 16 | * This program is distributed in the hope that it will be useful, | |
| 17 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 19 | * GNU General Public License for more details. | |
| 20 | * | |
| 21 | * You should have received a copy of the GNU General Public License | |
| 22 | * along with this program; if not, write to the Free Software | |
|
19859
71d37b57eff2
The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
15931
diff
changeset
|
23 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA |
| 11475 | 24 | */ |
| 25 | ||
|
15562
8c8249fe5e3c
gaim_gtk to pidgin. I hope
Sean Egan <seanegan@pidgin.im>
parents:
15435
diff
changeset
|
26 | #ifndef _PIDGINWHITEBOARD_H_ |
|
8c8249fe5e3c
gaim_gtk to pidgin. I hope
Sean Egan <seanegan@pidgin.im>
parents:
15435
diff
changeset
|
27 | #define _PIDGINWHITEBOARD_H_ |
| 11475 | 28 | |
| 15577 | 29 | #include "pidgin.h" |
| 11475 | 30 | |
| 31 | #include "whiteboard.h" | |
| 32 | ||
|
11914
81ac838f3824
[gaim-migrate @ 14205]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
11802
diff
changeset
|
33 | #define FULL_CIRCLE_DEGREES 23040 |
| 11475 | 34 | |
|
11914
81ac838f3824
[gaim-migrate @ 14205]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
11802
diff
changeset
|
35 | /* TODO: Make into an enum. */ |
|
81ac838f3824
[gaim-migrate @ 14205]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
11802
diff
changeset
|
36 | #define BRUSH_STATE_UP 0 |
|
81ac838f3824
[gaim-migrate @ 14205]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
11802
diff
changeset
|
37 | #define BRUSH_STATE_DOWN 1 |
|
81ac838f3824
[gaim-migrate @ 14205]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
11802
diff
changeset
|
38 | #define BRUSH_STATE_MOTION 2 |
| 11475 | 39 | |
|
35405
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
40 | /* XXX: This seems duplicated with the Yahoo! Doodle protocol code. |
|
11914
81ac838f3824
[gaim-migrate @ 14205]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
11802
diff
changeset
|
41 | * XXX: How should they work together? */ |
|
81ac838f3824
[gaim-migrate @ 14205]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
11802
diff
changeset
|
42 | #define PALETTE_NUM_COLORS 7 |
| 11475 | 43 | |
|
33113
73e1a4f7a1a9
Privatize some GtkWhiteboard fields.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
32790
diff
changeset
|
44 | typedef struct _PidginWhiteboardPrivate PidginWhiteboardPrivate; |
|
73e1a4f7a1a9
Privatize some GtkWhiteboard fields.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
32790
diff
changeset
|
45 | |
|
73e1a4f7a1a9
Privatize some GtkWhiteboard fields.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
32790
diff
changeset
|
46 | /** |
|
35405
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
47 | * PidginWhiteboard: |
|
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
48 | * @priv: Internal data |
|
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
49 | * @wb: Backend data for this whiteboard |
|
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
50 | * @window: Window for the Doodle session |
|
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
51 | * @drawing_area: Drawing area |
|
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
52 | * @width: Canvas width |
|
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
53 | * @height: Canvas height |
|
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
54 | * @brush_color: Foreground color |
|
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
55 | * @brush_size: Brush size |
|
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
56 | * |
|
15562
8c8249fe5e3c
gaim_gtk to pidgin. I hope
Sean Egan <seanegan@pidgin.im>
parents:
15435
diff
changeset
|
57 | * A PidginWhiteboard |
|
11802
b97b3fea95ce
[gaim-migrate @ 14093]
Gary Kramlich <grim@reaperworld.com>
parents:
11475
diff
changeset
|
58 | */ |
|
15562
8c8249fe5e3c
gaim_gtk to pidgin. I hope
Sean Egan <seanegan@pidgin.im>
parents:
15435
diff
changeset
|
59 | typedef struct _PidginWhiteboard |
| 11475 | 60 | { |
|
35405
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
61 | PidginWhiteboardPrivate *priv; |
|
11802
b97b3fea95ce
[gaim-migrate @ 14093]
Gary Kramlich <grim@reaperworld.com>
parents:
11475
diff
changeset
|
62 | |
|
35405
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
63 | PurpleWhiteboard *wb; |
|
11802
b97b3fea95ce
[gaim-migrate @ 14093]
Gary Kramlich <grim@reaperworld.com>
parents:
11475
diff
changeset
|
64 | |
|
35405
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
65 | GtkWidget *window; |
|
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
66 | GtkWidget *drawing_area; |
|
11802
b97b3fea95ce
[gaim-migrate @ 14093]
Gary Kramlich <grim@reaperworld.com>
parents:
11475
diff
changeset
|
67 | |
|
35405
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
68 | int width; |
|
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
69 | int height; |
|
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
70 | int brush_color; |
|
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
71 | int brush_size; |
|
15562
8c8249fe5e3c
gaim_gtk to pidgin. I hope
Sean Egan <seanegan@pidgin.im>
parents:
15435
diff
changeset
|
72 | } PidginWhiteboard; |
| 11475 | 73 | |
|
32790
b95c7c504118
Add G_BEGIN/END_DECLS to Pidgin public headers, most of which did
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
20147
diff
changeset
|
74 | G_BEGIN_DECLS |
| 11475 | 75 | |
|
11802
b97b3fea95ce
[gaim-migrate @ 14093]
Gary Kramlich <grim@reaperworld.com>
parents:
11475
diff
changeset
|
76 | /*****************************************************************************/ |
|
15562
8c8249fe5e3c
gaim_gtk to pidgin. I hope
Sean Egan <seanegan@pidgin.im>
parents:
15435
diff
changeset
|
77 | /** @name PidginWhiteboard API */ |
|
11802
b97b3fea95ce
[gaim-migrate @ 14093]
Gary Kramlich <grim@reaperworld.com>
parents:
11475
diff
changeset
|
78 | /*****************************************************************************/ |
|
b97b3fea95ce
[gaim-migrate @ 14093]
Gary Kramlich <grim@reaperworld.com>
parents:
11475
diff
changeset
|
79 | /*@{*/ |
|
b97b3fea95ce
[gaim-migrate @ 14093]
Gary Kramlich <grim@reaperworld.com>
parents:
11475
diff
changeset
|
80 | |
|
b97b3fea95ce
[gaim-migrate @ 14093]
Gary Kramlich <grim@reaperworld.com>
parents:
11475
diff
changeset
|
81 | /** |
|
35405
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
82 | * pidgin_whiteboard_get_ui_ops: |
|
d3f9e6dad44b
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
83 | * |
|
11802
b97b3fea95ce
[gaim-migrate @ 14093]
Gary Kramlich <grim@reaperworld.com>
parents:
11475
diff
changeset
|
84 | * Gets the GtkWhiteboard UI Operations. |
|
b97b3fea95ce
[gaim-migrate @ 14093]
Gary Kramlich <grim@reaperworld.com>
parents:
11475
diff
changeset
|
85 | * |
|
35393
00f876b129bc
Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents:
33167
diff
changeset
|
86 | * Returns: The GtkWhiteboard UI Operations. |
|
11802
b97b3fea95ce
[gaim-migrate @ 14093]
Gary Kramlich <grim@reaperworld.com>
parents:
11475
diff
changeset
|
87 | */ |
| 15884 | 88 | PurpleWhiteboardUiOps *pidgin_whiteboard_get_ui_ops( void ); |
| 11475 | 89 | |
|
11802
b97b3fea95ce
[gaim-migrate @ 14093]
Gary Kramlich <grim@reaperworld.com>
parents:
11475
diff
changeset
|
90 | /*@}*/ |
| 11475 | 91 | |
|
32790
b95c7c504118
Add G_BEGIN/END_DECLS to Pidgin public headers, most of which did
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
20147
diff
changeset
|
92 | G_END_DECLS |
| 11475 | 93 | |
|
15562
8c8249fe5e3c
gaim_gtk to pidgin. I hope
Sean Egan <seanegan@pidgin.im>
parents:
15435
diff
changeset
|
94 | #endif /* _PIDGINWHITEBOARD_H_ */ |