home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2007 September / PCWSEP07.iso / Software / Linux / Linux Mint 3.0 Light / LinuxMint-3.0-Light.iso / casper / filesystem.squashfs / usr / include / pidgin / gtksavedstatuses.h < prev    next >
Encoding:
C/C++ Source or Header  |  2007-05-04  |  2.8 KB  |  88 lines
  1. /**
  2.  * @file gtksavedstatuses.h GTK+ Saved Status Editor UI
  3.  * @ingroup pidgin
  4.  *
  5.  * pidgin
  6.  *
  7.  * Pidgin is the legal property of its developers, whose names are too numerous
  8.  * to list here.  Please refer to the COPYRIGHT file distributed with this
  9.  * source distribution.
  10.  *
  11.  * This program is free software; you can redistribute it and/or modify
  12.  * it under the terms of the GNU General Public License as published by
  13.  * the Free Software Foundation; either version 2 of the License, or
  14.  * (at your option) any later version.
  15.  *
  16.  * This program is distributed in the hope that it will be useful,
  17.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19.  * GNU General Public License for more details.
  20.  *
  21.  * You should have received a copy of the GNU General Public License
  22.  * along with this program; if not, write to the Free Software
  23.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24.  */
  25. #ifndef _PIDGINSAVEDSTATUSES_H_
  26. #define _PIDGINSAVEDSTATUSES_H_
  27.  
  28. #include "savedstatuses.h"
  29. #include "status.h"
  30.  
  31. /**
  32.  * Shows the status window.
  33.  */
  34. void pidgin_status_window_show(void);
  35.  
  36. /**
  37.  * Hides the status window.
  38.  */
  39. void pidgin_status_window_hide(void);
  40.  
  41. /**
  42.  * Shows a status editor (used for adding a new saved status or
  43.  * editing an already existing saved status).
  44.  *
  45.  * @param edit   TRUE if we want to edit an existing saved
  46.  *               status or FALSE to create a new one.  You
  47.  *               can not edit transient statuses--they don't
  48.  *               have titles.  If you want to edit a transient
  49.  *               status, set this to FALSE and seed the dialog
  50.  *               with the transient status using the status
  51.  *               parameter to this function.
  52.  * @param status If edit is TRUE then this should be a
  53.  *               pointer to the PurpleSavedStatus to edit.
  54.  *               If edit is FALSE then this can be NULL,
  55.  *               or you can pass in a saved status to
  56.  *               seed the initial values of the new status.
  57.  */
  58. void pidgin_status_editor_show(gboolean edit, PurpleSavedStatus *status);
  59.  
  60. /**
  61.  * Creates a dropdown menu of saved statuses and calls a callback
  62.  * when one is selected
  63.  *
  64.  * @param status   The default saved_status to show as 'selected'
  65.  * @param callback The callback to call when the selection changes
  66.  * @return         The menu widget
  67.  */
  68. GtkWidget *pidgin_status_menu(PurpleSavedStatus *status, GCallback callback);
  69.  
  70. /**
  71.  * Returns the GTK+ status handle.
  72.  *
  73.  * @return The handle to the GTK+ status system.
  74.  */
  75. void *pidgin_status_get_handle(void);
  76.  
  77. /**
  78.  * Initializes the GTK+ status system.
  79.  */
  80. void pidgin_status_init(void);
  81.  
  82. /**
  83.  * Uninitializes the GTK+ status system.
  84.  */
  85. void pidgin_status_uninit(void);
  86.  
  87. #endif /* _PIDGINSAVEDSTATUSES_H_ */
  88.