annotate pidgin/gtkdocklet.h @ 21364:5a7202fa43a0

I figured a signal firing on a connection error would be useful.

/* 
 * System tray icon (aka docklet) plugin for Purple
 * 
 * Copyright (C) 2002-3 Robert McQueen <[e-mail]>
 * Copyright (C) 2003 Herman Bloggs <[e-mail]>
 * Inspired by a similar plugin by:
 *  John (J5) Palmieri <[e-mail]>
 * 
 * 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 of the
 * License, 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.
 */

#ifndef _GTKDOCKLET_H_
#define _GTKDOCKLET_H_

#include "status.h"

struct docklet_ui_ops
{
	void (*create)(void);
	void (*destroy)(void);
	void (*update_icon)(PurpleStatusPrimitive, gboolean, gboolean);
	void (*blank_icon)(void);
	void (*set_tooltip)(gchar *);
	GtkMenuPositionFunc position_menu;
	gboolean (*get_geometry)(gint *x, gint *y, gint *w, gint *h);
	GObject *(*get_gdk_screen)(void);
};


/* functions in gtkdocklet.c */
void pidgin_docklet_update_icon(void);
void pidgin_docklet_clicked(int);
void pidgin_docklet_embedded(void);
void pidgin_docklet_remove(void);
void pidgin_docklet_set_ui_ops(struct docklet_ui_ops *);
void pidgin_docklet_unload(void);
void pidgin_docklet_init(void);
void pidgin_docklet_uninit(void);
void*pidgin_docklet_get_handle(void);

/**
 * Get the geometry of the docklet. Any of the parameters may be
 * NULL if that value is not desired.
 *
 * @param x x coordinate of the top left corner of the docklet in screen coordinates
 * @param y y coordinate of the top left corner of the docklet in screen coordinates
 * @param w width of the docklet
 * @param h height of the docklet
 *
 * @return TRUE if the geometry was found, otherwise FALSE
 */
gboolean pidgin_docklet_get_geometry(gint *x, gint *y, gint *w, gint *h);

/**
 * Get the GdkScreen of the docklet. If the GdkScreen is not available, including
 * running on versions of Gtk/Gdk where GdkScreen does not exist (<2.2), NULL is
 * returned.
 *
 * @return GdkScreen if available, otherwise NULL
 */
GObject *pidgin_docklet_get_gdk_screen(void);

/* function in gtkdocklet-{x11,win32}.c */
void docklet_ui_init(void);

#endif /* _GTKDOCKLET_H_ */