pidgin/gtkdnd-hints.h

branch
gtkdoc-conversion
changeset 35416
35c615531b2a
parent 35393
00f876b129bc
child 35451
206524351826
child 37053
e8959e0f6a37
equal deleted inserted replaced
35415:ba28be1a7611 35416:35c615531b2a
26 26
27 #include <glib.h> 27 #include <glib.h>
28 #include <gtk/gtk.h> 28 #include <gtk/gtk.h>
29 29
30 /** 30 /**
31 * DndHintWindowId:
32 * @HINT_ARROW_UP: Up arrow.
33 * @HINT_ARROW_DOWN: Down arrow.
34 * @HINT_ARROW_LEFT: Left arrow.
35 * @HINT_ARROW_RIGHT: Right arrow.
36 *
31 * Conversation drag-and-drop arrow types. 37 * Conversation drag-and-drop arrow types.
32 */ 38 */
33 typedef enum 39 typedef enum
34 { 40 {
35 HINT_ARROW_UP, /**< Up arrow. */ 41 HINT_ARROW_UP,
36 HINT_ARROW_DOWN, /**< Down arrow. */ 42 HINT_ARROW_DOWN,
37 HINT_ARROW_LEFT, /**< Left arrow. */ 43 HINT_ARROW_LEFT,
38 HINT_ARROW_RIGHT /**< Right arrow. */ 44 HINT_ARROW_RIGHT
39 45
40 } DndHintWindowId; 46 } DndHintWindowId;
41 47
42 /** 48 /**
49 * DndHintPosition:
50 * @HINT_POSITION_RIGHT: Position to the right of a tab.
51 * @HINT_POSITION_LEFT: Position to the left of a tab.
52 * @HINT_POSITION_TOP: Position above a tab.
53 * @HINT_POSITION_BOTTOM: Position below a tab.
54 * @HINT_POSITION_CENTER: Position in the center of a tab.
55 *
43 * Conversation drag-and-drop arrow positions. 56 * Conversation drag-and-drop arrow positions.
44 */ 57 */
45 typedef enum { 58 typedef enum {
46 59
47 HINT_POSITION_RIGHT, /**< Position to the right of a tab. */ 60 HINT_POSITION_RIGHT,
48 HINT_POSITION_LEFT, /**< Position to the left of a tab. */ 61 HINT_POSITION_LEFT,
49 HINT_POSITION_TOP, /**< Position above a tab. */ 62 HINT_POSITION_TOP,
50 HINT_POSITION_BOTTOM, /**< Position below a tab. */ 63 HINT_POSITION_BOTTOM,
51 HINT_POSITION_CENTER /**< Position in the center of a tab. */ 64 HINT_POSITION_CENTER
52 65
53 } DndHintPosition; 66 } DndHintPosition;
54 67
55 G_BEGIN_DECLS 68 G_BEGIN_DECLS
56 69
57 /** 70 /**
58 * Shows a drag-and-drop hint at the specified location. 71 * dnd_hints_show:
59 *
60 * @id: The ID of the hint to show. 72 * @id: The ID of the hint to show.
61 * @x: The X location to show it at. 73 * @x: The X location to show it at.
62 * @y: The Y location to show it at. 74 * @y: The Y location to show it at.
75 *
76 * Shows a drag-and-drop hint at the specified location.
63 */ 77 */
64 void dnd_hints_show(DndHintWindowId id, gint x, gint y); 78 void dnd_hints_show(DndHintWindowId id, gint x, gint y);
65 79
66 /** 80 /**
81 * dnd_hints_hide:
82 * @id: The ID of the hint to hide.
83 *
67 * Hides the specified drag-and-drop hint. 84 * Hides the specified drag-and-drop hint.
68 *
69 * @id: The ID of the hint to hide.
70 */ 85 */
71 void dnd_hints_hide(DndHintWindowId id); 86 void dnd_hints_hide(DndHintWindowId id);
72 87
73 /** 88 /**
89 * dnd_hints_hide_all:
90 *
74 * Hides all drag-and-drop hints. 91 * Hides all drag-and-drop hints.
75 */ 92 */
76 void dnd_hints_hide_all(void); 93 void dnd_hints_hide_all(void);
77 94
78 /** 95 /**
79 * Shows a drag-and-drop hint relative to a widget. 96 * dnd_hints_show_relative:
80 *
81 * @id: The ID of the hint. 97 * @id: The ID of the hint.
82 * @widget: The widget that the hint is relative to. 98 * @widget: The widget that the hint is relative to.
83 * @horiz: The horizontal relative position. 99 * @horiz: The horizontal relative position.
84 * @vert: The vertical relative position. 100 * @vert: The vertical relative position.
101 *
102 * Shows a drag-and-drop hint relative to a widget.
85 */ 103 */
86 void dnd_hints_show_relative(DndHintWindowId id, GtkWidget *widget, 104 void dnd_hints_show_relative(DndHintWindowId id, GtkWidget *widget,
87 DndHintPosition horiz, DndHintPosition vert); 105 DndHintPosition horiz, DndHintPosition vert);
88 106
89 G_END_DECLS 107 G_END_DECLS

mercurial