Codebase list xapp / debian/1.8.9-1 libxapp / xapp-status-icon.h
debian/1.8.9-1

Tree @debian/1.8.9-1 (Download .tar.gz)

xapp-status-icon.h @debian/1.8.9-1raw · history · blame

#ifndef __XAPP_STATUS_ICON_H__
#define __XAPP_STATUS_ICON_H__

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

#include <glib-object.h>

G_BEGIN_DECLS

#define XAPP_TYPE_STATUS_ICON            (xapp_status_icon_get_type ())

G_DECLARE_FINAL_TYPE (XAppStatusIcon, xapp_status_icon, XAPP, STATUS_ICON, GObject)

/**
 * XAppStatusIconState:
 * @XAPP_STATUS_ICON_STATE_NATIVE: The #XAppStatusIcon is currently being handled
 * by an #XAppStatusIconMonitor (usually in an applet).
 * @XAPP_STATUS_ICON_STATE_FALLBACK: The #XAppStatusIcon is currently being handled
 * by a legacy system tray implementation (using GtkStatusIcon).
 * @XAPP_STATUS_ICON_STATE_NO_SUPPORT: The #XAppStatusIcon is not currently being handled by any
 * kind of status icon implementation.
 */
typedef enum
{
    XAPP_STATUS_ICON_STATE_NATIVE,
    XAPP_STATUS_ICON_STATE_FALLBACK,
    XAPP_STATUS_ICON_STATE_NO_SUPPORT
} XAppStatusIconState;

/**
 * XAppScrollDirection:
 * @XAPP_SCROLL_UP: Scroll theoretical content up.
 * @XAPP_SCROLL_DOWN: Scroll theoretical content down.
 * @XAPP_SCROLL_LEFT: Scroll theoretical content left.
 * @XAPP_SCROLL_RIGHT: Scroll theoretical content right.
 *
 * Represents the direction of icon scroll events.
 */
typedef enum
{
  XAPP_SCROLL_UP,
  XAPP_SCROLL_DOWN,
  XAPP_SCROLL_LEFT,
  XAPP_SCROLL_RIGHT
} XAppScrollDirection;


XAppStatusIcon *xapp_status_icon_new                (void);
void            xapp_status_icon_set_name           (XAppStatusIcon *icon, const gchar *name);
void            xapp_status_icon_set_icon_name      (XAppStatusIcon *icon, const gchar *icon_name);
gint            xapp_status_icon_get_icon_size      (XAppStatusIcon *icon);
void            xapp_status_icon_set_tooltip_text   (XAppStatusIcon *icon, const gchar *tooltip_text);
void            xapp_status_icon_set_label          (XAppStatusIcon *icon, const gchar *label);
void            xapp_status_icon_set_visible        (XAppStatusIcon *icon, const gboolean visible);
gboolean        xapp_status_icon_get_visible        (XAppStatusIcon *icon);
void            xapp_status_icon_popup_menu         (XAppStatusIcon *icon,
                                                     GtkMenu        *menu,
                                                     gint            x,
                                                     gint            y,
                                                     guint           button,
                                                     guint           _time,
                                                     gint            panel_position);
void            xapp_status_icon_set_primary_menu   (XAppStatusIcon *icon, GtkMenu *menu);
GtkWidget      *xapp_status_icon_get_primary_menu   (XAppStatusIcon *icon);
void            xapp_status_icon_set_secondary_menu (XAppStatusIcon *icon, GtkMenu *menu);
GtkWidget      *xapp_status_icon_get_secondary_menu (XAppStatusIcon *icon);
XAppStatusIconState xapp_status_icon_get_state      (XAppStatusIcon *icon);
void            xapp_status_icon_set_metadata       (XAppStatusIcon *icon,
                                                     const gchar    *metadata);

/* static */
gboolean        xapp_status_icon_any_monitors       (void);
G_END_DECLS

#endif  /* __XAPP_STATUS_ICON_H__ */