pidgin/gtkdnd-hints.h

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