pidgin/gtkdnd-hints.h

/* Pidgin is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301, USA.
 */

#if !defined(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
# error "only <pidgin.h> may be included directly"
#endif

#ifndef _PIDGIN_DND_HINTS_H_
#define _PIDGIN_DND_HINTS_H_
/**
 * SECTION:gtkdnd-hints
 * @section_id: pidgin-gtkdnd-hints
 * @short_description: <filename>gtkdnd-hints.h</filename>
 * @title: Drag-and-Drop Arrow Hints
 */

#include <glib.h>
#include <gtk/gtk.h>

/**
 * PidginDndHintWindowId:
 * @HINT_ARROW_UP:    Up arrow.
 * @HINT_ARROW_DOWN:  Down arrow.
 * @HINT_ARROW_LEFT:  Left arrow.
 * @HINT_ARROW_RIGHT: Right arrow.
 *
 * Conversation drag-and-drop arrow types.
 */
typedef enum
{
	HINT_ARROW_UP,
	HINT_ARROW_DOWN,
	HINT_ARROW_LEFT,
	HINT_ARROW_RIGHT

} PidginDndHintWindowId;

/**
 * PidginDndHintPosition:
 * @HINT_POSITION_RIGHT:  Position to the right of a tab.
 * @HINT_POSITION_LEFT:   Position to the left of a tab.
 * @HINT_POSITION_TOP:    Position above a tab.
 * @HINT_POSITION_BOTTOM: Position below a tab.
 * @HINT_POSITION_CENTER: Position in the center of a tab.
 *
 * Conversation drag-and-drop arrow positions.
 */
typedef enum {

	HINT_POSITION_RIGHT,
	HINT_POSITION_LEFT,
	HINT_POSITION_TOP,
	HINT_POSITION_BOTTOM,
	HINT_POSITION_CENTER

} PidginDndHintPosition;

G_BEGIN_DECLS

/**
 * pidgin_dnd_hints_show:
 * @id: The ID of the hint to show.
 * @x:  The X location to show it at.
 * @y:  The Y location to show it at.
 *
 * Shows a drag-and-drop hint at the specified location.
 */
void pidgin_dnd_hints_show(PidginDndHintWindowId id, gint x, gint y);

/**
 * pidgin_dnd_hints_hide:
 * @id: The ID of the hint to hide.
 *
 * Hides the specified drag-and-drop hint.
 */
void pidgin_dnd_hints_hide(PidginDndHintWindowId id);

/**
 * pidgin_dnd_hints_hide_all:
 *
 * Hides all drag-and-drop hints.
 */
void pidgin_dnd_hints_hide_all(void);

/**
 * pidgin_dnd_hints_show_relative:
 * @id:     The ID of the hint.
 * @widget: The widget that the hint is relative to.
 * @horiz:  The horizontal relative position.
 * @vert:   The vertical relative position.
 *
 * Shows a drag-and-drop hint relative to a widget.
 */
void pidgin_dnd_hints_show_relative(PidginDndHintWindowId id, GtkWidget *widget,
							 PidginDndHintPosition horiz, PidginDndHintPosition vert);

G_END_DECLS

#endif /* _PIDGIN_DND_HINTS_H_ */