view src/gtksavedstatuses.h @ 12434:1811afd29b57

[gaim-migrate @ 14741] OSCAR, at least, is guilty of setting status messages on statuses which do not accept a message with some regularity. I'm betting other protocols have similar errors. This causes such errors to be logged as an error to the debug window, so that they can be tracked down and fixed. In general, we seem to be abusing g_return_if_fail -- it's intended to be an *assertion*, not a shortcut for normal return conditions. I think it complains (or can complain) to the debug window itself ... maybe we need to make it louder. committer: Tailor Script <[e-mail]>

/**
 * @file gtksavedstatuses.h GTK+ Saved Status Editor UI
 * @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 _GAIM_GTKSAVEDSTATUSES_H_
#define _GAIM_GTKSAVEDSTATUSES_H_

#include "savedstatuses.h"
#include "status.h"

/**
 * Shows the status window.
 */
void gaim_gtk_status_window_show(void);

/**
 * Hides the status window.
 */
void gaim_gtk_status_window_hide(void);

/**
 * Shows a status editor (used for adding a new saved status or
 * editing an already existing saved status).
 *
 * @param status The saved status to edit, or @c NULL if you
 *               want to add a new saved status.
 */
void gaim_gtk_status_editor_show(GaimSavedStatus *status);

/**
 * Returns the gtkstatus handle.
 *
 * @return The handle to the GTK+ status system.
 */
void *gaim_gtk_status_get_handle(void);

/**
 * Initializes the GTK+ status system.
 */
void gaim_gtk_status_init(void);

/**
 * Uninitializes the GTK+ status system.
 */
void gaim_gtk_status_uninit(void);

/**
 * Creates a dropdown menu of saved statuses and calls a callback
 * when one is selected
 *
 * @param status   The default saved_status to show as 'selected'
 * @param callback The callback to call when the selection changes
 * @return         The menu widget
 */
GtkWidget *gaim_gtk_status_menu(GaimSavedStatus *status, GCallback callback);

#endif /* _GAIM_GTKSAVEDSTATUSES_H_ */