pidgin/gtksavedstatuses.h

   1 /* pidgin
   2  *
   3  * Pidgin is the legal property of its developers, whose names are too numerous
   4  * to list here.  Please refer to the COPYRIGHT file distributed with this
   5  * source distribution.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  20  */
  21
  22 #ifndef _PIDGINSAVEDSTATUSES_H_
  23 #define _PIDGINSAVEDSTATUSES_H_
  24 /**
  25  * SECTION:gtksavedstatuses
  26  * @section_id: pidgin-gtksavedstatuses
  27  * @short_description: <filename>gtksavedstatuses.h</filename>
  28  * @title: Saved Status Editor UI
  29  */
  30
  31 #include "savedstatuses.h"
  32 #include "status.h"
  33
  34 G_BEGIN_DECLS
  35
  36 /**
  37  * pidgin_status_window_show:
  38  *
  39  * Shows the status window.
  40  */
  41 void pidgin_status_window_show(void);
  42
  43 /**
  44  * pidgin_status_window_hide:
  45  *
  46  * Hides the status window.
  47  */
  48 void pidgin_status_window_hide(void);
  49
  50 /**
  51  * pidgin_status_editor_show:
  52  * @edit:   %TRUE if we want to edit an existing saved
  53  *               status or %FALSE to create a new one.  You
  54  *               can not edit transient statuses--they don't
  55  *               have titles.  If you want to edit a transient
  56  *               status, set this to %FALSE and seed the dialog
  57  *               with the transient status using the status
  58  *               parameter to this function.
  59  * @status: If edit is %TRUE then this should be a
  60  *               pointer to the PurpleSavedStatus to edit.
  61  *               If edit is %FALSE then this can be NULL,
  62  *               or you can pass in a saved status to
  63  *               seed the initial values of the new status.
  64  *
  65  * Shows a status editor (used for adding a new saved status or
  66  * editing an already existing saved status).
  67  */
  68 void pidgin_status_editor_show(gboolean edit, PurpleSavedStatus *status);
  69
  70 /**
  71  * pidgin_status_menu:
  72  * @status:   The default saved_status to show as 'selected'
  73  * @callback: (scope call): The callback to call when the selection changes
  74  *
  75  * Creates a dropdown menu of saved statuses and calls a callback
  76  * when one is selected
  77  *
  78  * Returns: (transfer full): The menu widget
  79  */
  80 GtkWidget *pidgin_status_menu(PurpleSavedStatus *status, GCallback callback);
  81
  82 /**
  83  * pidgin_status_get_handle:
  84  *
  85  * Returns the GTK+ status handle.
  86  *
  87  * Returns: The handle to the GTK+ status system.
  88  */
  89 void *pidgin_status_get_handle(void);
  90
  91 /**
  92  * pidgin_status_init:
  93  *
  94  * Initializes the GTK+ status system.
  95  */
  96 void pidgin_status_init(void);
  97
  98 /**
  99  * pidgin_status_uninit:
 100  *
 101  * Uninitializes the GTK+ status system.
 102  */
 103 void pidgin_status_uninit(void);
 104
 105 G_END_DECLS
 106
 107 #endif /* _PIDGINSAVEDSTATUSES_H_ */