pidgin/gtkdnd-hints.h

   1 /* Pidgin is the legal property of its developers, whose names are too numerous
   2  * to list here.  Please refer to the COPYRIGHT file distributed with this
   3  * source distribution.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2, or (at your option)
   8  * any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301, USA.
  18  */
  19
  20 #ifndef _PIDGIN_DND_HINTS_H_
  21 #define _PIDGIN_DND_HINTS_H_
  22 /**
  23  * SECTION:gtkdnd-hints
  24  * @section_id: pidgin-gtkdnd-hints
  25  * @short_description: <filename>gtkdnd-hints.h</filename>
  26  * @title: Drag-and-Drop Arrow Hints
  27  */
  28
  29 #include <glib.h>
  30 #include <gtk/gtk.h>
  31
  32 /**
  33  * PidginDndHintWindowId:
  34  * @HINT_ARROW_UP:    Up arrow.
  35  * @HINT_ARROW_DOWN:  Down arrow.
  36  * @HINT_ARROW_LEFT:  Left arrow.
  37  * @HINT_ARROW_RIGHT: Right arrow.
  38  *
  39  * Conversation drag-and-drop arrow types.
  40  */
  41 typedef enum
  42 {
  43         HINT_ARROW_UP,
  44         HINT_ARROW_DOWN,
  45         HINT_ARROW_LEFT,
  46         HINT_ARROW_RIGHT
  47
  48 } PidginDndHintWindowId;
  49
  50 /**
  51  * PidginDndHintPosition:
  52  * @HINT_POSITION_RIGHT:  Position to the right of a tab.
  53  * @HINT_POSITION_LEFT:   Position to the left of a tab.
  54  * @HINT_POSITION_TOP:    Position above a tab.
  55  * @HINT_POSITION_BOTTOM: Position below a tab.
  56  * @HINT_POSITION_CENTER: Position in the center of a tab.
  57  *
  58  * Conversation drag-and-drop arrow positions.
  59  */
  60 typedef enum {
  61
  62         HINT_POSITION_RIGHT,
  63         HINT_POSITION_LEFT,
  64         HINT_POSITION_TOP,
  65         HINT_POSITION_BOTTOM,
  66         HINT_POSITION_CENTER
  67
  68 } PidginDndHintPosition;
  69
  70 G_BEGIN_DECLS
  71
  72 /**
  73  * pidgin_dnd_hints_show:
  74  * @id: The ID of the hint to show.
  75  * @x:  The X location to show it at.
  76  * @y:  The Y location to show it at.
  77  *
  78  * Shows a drag-and-drop hint at the specified location.
  79  */
  80 void pidgin_dnd_hints_show(PidginDndHintWindowId id, gint x, gint y);
  81
  82 /**
  83  * pidgin_dnd_hints_hide:
  84  * @id: The ID of the hint to hide.
  85  *
  86  * Hides the specified drag-and-drop hint.
  87  */
  88 void pidgin_dnd_hints_hide(PidginDndHintWindowId id);
  89
  90 /**
  91  * pidgin_dnd_hints_hide_all:
  92  *
  93  * Hides all drag-and-drop hints.
  94  */
  95 void pidgin_dnd_hints_hide_all(void);
  96
  97 /**
  98  * pidgin_dnd_hints_show_relative:
  99  * @id:     The ID of the hint.
 100  * @widget: The widget that the hint is relative to.
 101  * @horiz:  The horizontal relative position.
 102  * @vert:   The vertical relative position.
 103  *
 104  * Shows a drag-and-drop hint relative to a widget.
 105  */
 106 void pidgin_dnd_hints_show_relative(PidginDndHintWindowId id, GtkWidget *widget,
 107                                                          PidginDndHintPosition horiz, PidginDndHintPosition vert);
 108
 109 G_END_DECLS
 110
 111 #endif /* _PIDGIN_DND_HINTS_H_ */