pidgin/gtkprivacy.h

   1 /**
   2  * @file gtkprivacy.h GTK+ Privacy UI
   3  * @ingroup pidgin
   4  */
   5
   6 /* pidgin
   7  *
   8  * Pidgin is the legal property of its developers, whose names are too numerous
   9  * to list here.  Please refer to the COPYRIGHT file distributed with this
  10  * source distribution.
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  25  */
  26 #ifndef _PIDGINPRIVACY_H_
  27 #define _PIDGINPRIVACY_H_
  28
  29 #include "privacy.h"
  30
  31 /**
  32  * Initializes the GTK+ privacy subsystem.
  33  */
  34 void pidgin_privacy_init(void);
  35
  36 /**
  37  * Shows the privacy dialog.
  38  */
  39 void pidgin_privacy_dialog_show(void);
  40
  41 /**
  42  * Hides the privacy dialog.
  43  */
  44 void pidgin_privacy_dialog_hide(void);
  45
  46 /**
  47  * Requests confirmation to add a user to the allow list for an account,
  48  * and then adds it.
  49  *
  50  * If @a name is not specified, an input dialog will be presented.
  51  *
  52  * @param account The account.
  53  * @param name    The name of the user to add.
  54  */
  55 void pidgin_request_add_permit(PurpleAccount *account, const char *name);
  56
  57 /**
  58  * Requests confirmation to add a user to the block list for an account,
  59  * and then adds it.
  60  *
  61  * If @a name is not specified, an input dialog will be presented.
  62  *
  63  * @param account The account.
  64  * @param name    The name of the user to add.
  65  */
  66 void pidgin_request_add_block(PurpleAccount *account, const char *name);
  67
  68 /**
  69  * Returns the UI operations structure for the GTK+ privacy subsystem.
  70  *
  71  * @return The GTK+ UI privacy operations structure.
  72  */
  73 PurplePrivacyUiOps *pidgin_privacy_get_ui_ops(void);
  74
  75 #endif /* _PIDGINPRIVACY_H_ */