Mercurial > pidgin
view libpurple/plugins/pluginpref_example.c @ 32174:63e7d226b760
Re-arrange these doxygen comments. For comments longer than a few words,
putting the comment before the variable like this seems cleaner than trying
to cram it on the same line as the variable and using lots of crazy
indentation. Anyone have a strong opinion either way?
| author | Mark Doliner <mark@kingant.net> |
|---|---|
| date | Sun, 18 Sep 2011 20:18:33 +0000 |
| parents | 3cc856ca2338 |
| children |
line wrap: on
line source
/* * PluginPref Example Plugin * * Copyright (C) 2004, Gary Kramlich <amc_grim@users.sf.net> * * 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., 51 Franklin Street, Fifth Floor, Boston, MA * 02111-1301, USA. */ #ifdef HAVE_CONFIG_H # include <config.h> #endif #ifndef PURPLE_PLUGINS # define PURPLE_PLUGINS #endif #include "internal.h" #include "plugin.h" #include "pluginpref.h" #include "prefs.h" #include "version.h" static PurplePluginPrefFrame * get_plugin_pref_frame(PurplePlugin *plugin) { PurplePluginPrefFrame *frame; PurplePluginPref *ppref; frame = purple_plugin_pref_frame_new(); ppref = purple_plugin_pref_new_with_label("boolean"); purple_plugin_pref_frame_add(frame, ppref); ppref = purple_plugin_pref_new_with_name_and_label( "/plugins/core/pluginpref_example/bool", "boolean pref"); purple_plugin_pref_frame_add(frame, ppref); ppref = purple_plugin_pref_new_with_label("integer"); purple_plugin_pref_frame_add(frame, ppref); ppref = purple_plugin_pref_new_with_name_and_label( "/plugins/core/pluginpref_example/int", "integer pref"); purple_plugin_pref_set_bounds(ppref, 0, 255); purple_plugin_pref_frame_add(frame, ppref); ppref = purple_plugin_pref_new_with_name_and_label( "/plugins/core/pluginpref_example/int_choice", "integer choice"); purple_plugin_pref_set_type(ppref, PURPLE_PLUGIN_PREF_CHOICE); purple_plugin_pref_add_choice(ppref, "One", GINT_TO_POINTER(1)); purple_plugin_pref_add_choice(ppref, "Two", GINT_TO_POINTER(2)); purple_plugin_pref_add_choice(ppref, "Four", GINT_TO_POINTER(4)); purple_plugin_pref_add_choice(ppref, "Eight", GINT_TO_POINTER(8)); purple_plugin_pref_add_choice(ppref, "Sixteen", GINT_TO_POINTER(16)); purple_plugin_pref_add_choice(ppref, "Thirty Two", GINT_TO_POINTER(32)); purple_plugin_pref_add_choice(ppref, "Sixty Four", GINT_TO_POINTER(64)); purple_plugin_pref_add_choice(ppref, "One Hundred Twenty Eight", GINT_TO_POINTER(128)); purple_plugin_pref_frame_add(frame, ppref); ppref = purple_plugin_pref_new_with_label("string"); purple_plugin_pref_frame_add(frame, ppref); ppref = purple_plugin_pref_new_with_name_and_label( "/plugins/core/pluginpref_example/string", "string pref"); purple_plugin_pref_frame_add(frame, ppref); ppref = purple_plugin_pref_new_with_name_and_label( "/plugins/core/pluginpref_example/masked_string", "masked string"); purple_plugin_pref_set_masked(ppref, TRUE); purple_plugin_pref_frame_add(frame, ppref); ppref = purple_plugin_pref_new_with_name_and_label( "/plugins/core/pluginpref_example/max_string", "string pref\n(max length of 16)"); purple_plugin_pref_set_max_length(ppref, 16); purple_plugin_pref_frame_add(frame, ppref); ppref = purple_plugin_pref_new_with_name_and_label( "/plugins/core/pluginpref_example/string_choice", "string choice"); purple_plugin_pref_set_type(ppref, PURPLE_PLUGIN_PREF_CHOICE); purple_plugin_pref_add_choice(ppref, "red", "red"); purple_plugin_pref_add_choice(ppref, "orange", "orange"); purple_plugin_pref_add_choice(ppref, "yellow", "yellow"); purple_plugin_pref_add_choice(ppref, "green", "green"); purple_plugin_pref_add_choice(ppref, "blue", "blue"); purple_plugin_pref_add_choice(ppref, "purple", "purple"); purple_plugin_pref_frame_add(frame, ppref); return frame; } static PurplePluginUiInfo prefs_info = { get_plugin_pref_frame, 0, /* page_num (Reserved) */ NULL, /* frame (Reserved) */ /* Padding */ NULL, NULL, NULL, NULL }; static PurplePluginInfo info = { PURPLE_PLUGIN_MAGIC, PURPLE_MAJOR_VERSION, PURPLE_MINOR_VERSION, PURPLE_PLUGIN_STANDARD, /**< type */ NULL, /**< ui_requirement */ 0, /**< flags */ NULL, /**< dependencies */ PURPLE_PRIORITY_DEFAULT, /**< priority */ "core-pluginpref_example", /**< id */ "Pluginpref Example", /**< name */ DISPLAY_VERSION, /**< version */ /** summary */ "An example of how to use pluginprefs", /** description */ "An example of how to use pluginprefs", "Gary Kramlich <amc_grim@users.sf.net>", /**< author */ PURPLE_WEBSITE, /**< homepage */ NULL, /**< load */ NULL, /**< unload */ NULL, /**< destroy */ NULL, /**< ui_info */ NULL, /**< extra_info */ &prefs_info, /**< prefs_info */ NULL, /**< actions */ /* padding */ NULL, NULL, NULL, NULL }; static void init_plugin(PurplePlugin *plugin) { purple_prefs_add_none("/plugins/core/pluginpref_example"); purple_prefs_add_bool("/plugins/core/pluginpref_example/bool", TRUE); purple_prefs_add_int("/plugins/core/pluginpref_example/int", 0); purple_prefs_add_int("/plugins/core/pluginpref_example/int_choice", 1); purple_prefs_add_string("/plugins/core/pluginpref_example/string", "string"); purple_prefs_add_string("/plugins/core/pluginpref_example/max_string", "max length string"); purple_prefs_add_string("/plugins/core/pluginpref_example/masked_string", "masked"); purple_prefs_add_string("/plugins/core/pluginpref_example/string_choice", "red"); } PURPLE_INIT_PLUGIN(ppexample, init_plugin, info)