annotate src/gtkstatusbox.h @ 11986:bfbb1798535e

[gaim-migrate @ 14279] Switch to using the unicode character 0x25cf instead of an asterisk as our password masking character. In the words of the great Christian Hammond, "By the way, isn't it about time we replace the asterisk in masked entries with that unicode character for the round filled circle ("?")? The asterisk is so 1980s." committer: Tailor Script <[e-mail]>

/*
 * @file gtkstatusbox.c GTK+ Status Selection Widget
 * @ingroup gtkui
 *
 * gaim
 *
 * Gaim 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 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


#ifndef __GTK_GAIM_STATUS_BOX_H__
#define __GTK_GAIM_STATUS_BOX_H__

#include <gtk/gtk.h>
#include "gtkimhtml.h"
#include "account.h"
#include "savedstatuses.h"
#include "status.h"
#include <gtk/gtktreemodel.h>
#include <gtk/gtktreeview.h>
#if !GTK_CHECK_VERSION(2,6,0)
#	include "gtkcellview.h"
#	include "gtkcellviewmenuitem.h"
#	if !GTK_CHECK_VERSION(2,4,0)
#		include "gtkcelllayout.h"
#		include "gtkcombobox.h"
#	endif /* Gtk 2.4 */
#endif /* Gtk 2.6 */

G_BEGIN_DECLS

#define GTK_GAIM_TYPE_STATUS_BOX             (gtk_gaim_status_box_get_type ())
#define GTK_GAIM_STATUS_BOX(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_GAIM_TYPE_STATUS_BOX, GtkGaimStatusBox))
#define GTK_GAIM_STATUS_BOX_CLASS(vtable)    (G_TYPE_CHECK_CLASS_CAST ((vtable), GTK_GAIM_TYPE_STATUS_BOX, GtkGaimStatusBoxClass))
#define GTK_GAIM_IS_STATUS_BOX(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_GAIM_TYPE_STATUS_BOX))
#define GTK_GAIM_IS_STATUS_BOX_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), GTK_GAIM_TYPE_STATUS_BOX))
#define GTK_GAIM_STATUS_BOX_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), GTK_GAIM_TYPE_STATUS_BOX, GtkGaimStatusBoxClass))

/**
 * This is a hidden field in the GtkStatusBox that identifies the
 * item in the list store.  The item could be a normal
 * GaimStatusPrimitive, or it could be something special like the
 * "Custom..." item, or "Saved..." or a GtkSeparator.
 */
typedef enum
{
	/*
	 * The first 0 through GAIM_STATUS_NUM_PRIMITIVES
	 * correspond to GaimStatusPrimitives.
	 */
	GTK_GAIM_STATUS_BOX_TYPE_SEPARATOR = GAIM_STATUS_NUM_PRIMITIVES,
	GTK_GAIM_STATUS_BOX_TYPE_CUSTOM,
	GTK_GAIM_STATUS_BOX_TYPE_SAVED,
	GTK_GAIM_STATUS_BOX_NUM_TYPES
} GtkGaimStatusBoxItemType;

typedef struct _GtkGaimStatusBox      GtkGaimStatusBox;
typedef struct _GtkGaimStatusBoxClass GtkGaimStatusBoxClass;

struct _GtkGaimStatusBox
{
	GtkComboBox parent_instance;

	/**
	 * This GtkListStore contains only one row--the currently selected status.
	 */
	GtkListStore *store;

	/**
	 * This is the dropdown GtkListStore that contains the available statuses,
	 * plus some recently used statuses, plus the "Custom..." and "Saved..."
	 * options.
	 */
	GtkListStore *dropdown_store;

	GaimAccount *account;

	GtkWidget *vbox, *sw;
	GtkWidget *imhtml;
	gboolean imhtml_visible;

	GtkWidget *cell_view;
	GtkCellRenderer *icon_rend;
	GtkCellRenderer *text_rend;

	GdkPixbuf *error_pixbuf;
	int connecting_index;
	GdkPixbuf *connecting_pixbufs[4];
	int typing_index;
	GdkPixbuf *typing_pixbufs[4];

	gboolean connecting;
	gboolean typing;


	GtkTreeIter iter;
	GdkPixbuf *pixbuf;
	char *title;
	char *desc;
	char *error;

	gulong status_changed_signal;
};

struct _GtkGaimStatusBoxClass
{
  GtkComboBoxClass parent_class;

  /* signals */
  void     (* changed)          (GtkComboBox *combo_box);

  /* Padding for future expansion */
  void (*_gtk_reserved0) (void);
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
};


GType         gtk_gaim_status_box_get_type         (void) G_GNUC_CONST;
GtkWidget    *gtk_gaim_status_box_new              (void);
GtkWidget    *gtk_gaim_status_box_new_with_account (GaimAccount *);

void
gtk_gaim_status_box_add(GtkGaimStatusBox *status_box, GtkGaimStatusBoxItemType type, GdkPixbuf *pixbuf, const char *text, const char *sec_text);

void
gtk_gaim_status_box_add_separator(GtkGaimStatusBox *status_box);

void
gtk_gaim_status_box_set_error(GtkGaimStatusBox *status_box, const gchar *error);

void
gtk_gaim_status_box_set_connecting(GtkGaimStatusBox *status_box, gboolean connecting);

void
gtk_gaim_status_box_pulse_connecting(GtkGaimStatusBox *status_box);

GtkGaimStatusBoxItemType gtk_gaim_status_box_get_active_type(GtkGaimStatusBox *status_box);

char *gtk_gaim_status_box_get_message(GtkGaimStatusBox *status_box);

G_END_DECLS

#endif /* __GTK_GAIM_GTK_STATUS_COMBO_BOX_H__ */