pidgin/pidgin
Clone
Summary
Browse
Changes
Graph
Fix various small documentation errors
19 months ago, Elliott Sales de Andrade
316c1207f787
Fix various small documentation errors
Fix missing transfer annotations, remove old syntax from gtk-doc, correct an `element-type` annotation, and fix a typo.
Testing Done:
Compiled with docs on, and got fewer warnings. Also functions with added transfer annotations are no longer unavailable to bindings.
Reviewed at https://reviews.imfreedom.org/r/1855/
/* pidgin
*
* Pidgin 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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#include
<talkatu.h>
#include
<purple.h>
#include
"gtkpluginpref.h"
#include
"gtkutils.h"
#include
"pidginprefs.h"
static
gboolean
entry_cb
(
GtkWidget
*
entry
,
gpointer
data
)
{
char
*
pref
=
data
;
purple_prefs_set_string
(
pref
,
gtk_editable_get_text
(
GTK_EDITABLE
(
entry
)));
return
FALSE
;
}
static
void
multiline_cb
(
GtkTextBuffer
*
buffer
,
gpointer
data
)
{
gchar
*
pref
=
NULL
,
*
text
=
NULL
;
pref
=
g_object_get_data
(
G_OBJECT
(
buffer
),
"pref-key"
);
g_return_if_fail
(
pref
);
text
=
talkatu_markup_get_html
(
buffer
,
NULL
);
purple_prefs_set_string
(
pref
,
text
);
g_free
(
text
);
}
static
void
make_string_pref
(
GtkWidget
*
parent
,
PurplePluginPref
*
pref
,
GtkSizeGroup
*
sg
)
{
GtkWidget
*
box
,
*
gtk_label
,
*
entry
;
const
gchar
*
pref_name
;
const
gchar
*
pref_label
;
PurpleStringFormatType
format
;
pref_name
=
purple_plugin_pref_get_name
(
pref
);
pref_label
=
purple_plugin_pref_get_label
(
pref
);
format
=
purple_plugin_pref_get_format_type
(
pref
);
switch
(
purple_plugin_pref_get_pref_type
(
pref
))
{
case
PURPLE_PLUGIN_PREF_CHOICE
:
gtk_label
=
pidgin_prefs_dropdown_from_list
(
parent
,
pref_label
,
PURPLE_PREF_STRING
,
pref_name
,
purple_plugin_pref_get_choices
(
pref
));
gtk_label_set_xalign
(
GTK_LABEL
(
gtk_label
),
0
);
if
(
sg
)
gtk_size_group_add_widget
(
sg
,
gtk_label
);
break
;
case
PURPLE_PLUGIN_PREF_NONE
:
default
:
if
(
format
==
PURPLE_STRING_FORMAT_TYPE_NONE
)
{
entry
=
gtk_entry_new
();
gtk_editable_set_text
(
GTK_EDITABLE
(
entry
),
purple_prefs_get_string
(
pref_name
));
gtk_entry_set_max_length
(
GTK_ENTRY
(
entry
),
purple_plugin_pref_get_max_length
(
pref
));
if
(
purple_plugin_pref_get_masked
(
pref
))
{
gtk_entry_set_visibility
(
GTK_ENTRY
(
entry
),
FALSE
);
}
g_signal_connect
(
G_OBJECT
(
entry
),
"changed"
,
G_CALLBACK
(
entry_cb
),
(
gpointer
)
pref_name
);
pidgin_add_widget_to_vbox
(
GTK_BOX
(
parent
),
pref_label
,
sg
,
entry
,
TRUE
,
NULL
);
}
else
{
GtkWidget
*
hbox
;
GtkWidget
*
spacer
;
GtkWidget
*
editor
;
GtkWidget
*
input
;
GtkTextBuffer
*
buffer
;
box
=
gtk_box_new
(
GTK_ORIENTATION_VERTICAL
,
6
);
gtk_widget_show
(
box
);
gtk_box_append
(
GTK_BOX
(
parent
),
box
);
gtk_label
=
gtk_label_new_with_mnemonic
(
pref_label
);
gtk_label_set_xalign
(
GTK_LABEL
(
gtk_label
),
0
);
gtk_widget_show
(
gtk_label
);
gtk_box_append
(
GTK_BOX
(
box
),
gtk_label
);
if
(
sg
)
gtk_size_group_add_widget
(
sg
,
gtk_label
);
hbox
=
gtk_box_new
(
GTK_ORIENTATION_HORIZONTAL
,
6
);
gtk_box_append
(
GTK_BOX
(
box
),
hbox
);
gtk_widget_show
(
hbox
);
spacer
=
gtk_label_new
(
" "
);
gtk_box_append
(
GTK_BOX
(
hbox
),
spacer
);
gtk_widget_show
(
spacer
);
editor
=
talkatu_editor_new
();
input
=
talkatu_editor_get_input
(
TALKATU_EDITOR
(
editor
));
if
((
format
&
PURPLE_STRING_FORMAT_TYPE_HTML
)
!=
0
)
{
buffer
=
talkatu_html_buffer_new
();
}
else
{
buffer
=
talkatu_buffer_new
(
NULL
);
}
gtk_text_view_set_buffer
(
GTK_TEXT_VIEW
(
input
),
buffer
);
if
(
format
&
PURPLE_STRING_FORMAT_TYPE_MULTILINE
)
{
gchar
*
tmp
=
purple_strreplace
(
purple_prefs_get_string
(
pref_name
),
"
\n
"
,
"<br>"
);
talkatu_markup_set_html
(
TALKATU_BUFFER
(
buffer
),
tmp
,
-1
);
g_free
(
tmp
);
}
else
{
talkatu_markup_set_html
(
TALKATU_BUFFER
(
buffer
),
purple_prefs_get_string
(
pref_name
),
-1
);
}
gtk_label_set_mnemonic_widget
(
GTK_LABEL
(
gtk_label
),
input
);
g_object_set_data
(
G_OBJECT
(
buffer
),
"pref-key"
,
(
gpointer
)
pref_name
);
g_signal_connect
(
G_OBJECT
(
buffer
),
"changed"
,
G_CALLBACK
(
multiline_cb
),
NULL
);
#warning fix this when talkatu has a solution
/*
g_signal_connect(G_OBJECT(view), "format-toggled",
G_CALLBACK(multiline_cb), NULL);
*/
gtk_box_append
(
GTK_BOX
(
hbox
),
editor
);
gtk_widget_set_hexpand
(
editor
,
TRUE
);
}
break
;
}
}
static
void
make_int_pref
(
GtkWidget
*
parent
,
PurplePluginPref
*
pref
,
GtkSizeGroup
*
sg
)
{
GtkWidget
*
gtk_label
;
const
gchar
*
pref_name
;
const
gchar
*
pref_label
;
gint
max
,
min
;
pref_name
=
purple_plugin_pref_get_name
(
pref
);
pref_label
=
purple_plugin_pref_get_label
(
pref
);
switch
(
purple_plugin_pref_get_pref_type
(
pref
))
{
case
PURPLE_PLUGIN_PREF_CHOICE
:
gtk_label
=
pidgin_prefs_dropdown_from_list
(
parent
,
pref_label
,
PURPLE_PREF_INT
,
pref_name
,
purple_plugin_pref_get_choices
(
pref
));
gtk_label_set_xalign
(
GTK_LABEL
(
gtk_label
),
0
);
if
(
sg
)
gtk_size_group_add_widget
(
sg
,
gtk_label
);
break
;
case
PURPLE_PLUGIN_PREF_NONE
:
default
:
purple_plugin_pref_get_bounds
(
pref
,
&
min
,
&
max
);
pidgin_prefs_labeled_spin_button
(
parent
,
pref_label
,
pref_name
,
min
,
max
,
sg
);
break
;
}
}
static
void
make_info_pref
(
GtkWidget
*
parent
,
PurplePluginPref
*
pref
)
{
GtkWidget
*
gtk_label
=
gtk_label_new
(
purple_plugin_pref_get_label
(
pref
));
gtk_label_set_xalign
(
GTK_LABEL
(
gtk_label
),
0
);
gtk_label_set_yalign
(
GTK_LABEL
(
gtk_label
),
0
);
gtk_label_set_wrap
(
GTK_LABEL
(
gtk_label
),
TRUE
);
gtk_box_append
(
GTK_BOX
(
parent
),
gtk_label
);
gtk_widget_show
(
gtk_label
);
}
GtkWidget
*
pidgin_plugin_pref_create_frame
(
PurplePluginPrefFrame
*
frame
)
{
GtkWidget
*
ret
,
*
parent
;
GtkSizeGroup
*
sg
;
GList
*
pp
;
g_return_val_if_fail
(
frame
,
NULL
);
sg
=
gtk_size_group_new
(
GTK_SIZE_GROUP_HORIZONTAL
);
parent
=
ret
=
gtk_box_new
(
GTK_ORIENTATION_VERTICAL
,
16
);
gtk_widget_show
(
ret
);
for
(
pp
=
purple_plugin_pref_frame_get_prefs
(
frame
);
pp
!=
NULL
;
pp
=
pp
->
next
)
{
PurplePluginPref
*
pref
=
(
PurplePluginPref
*
)
pp
->
data
;
const
char
*
name
=
purple_plugin_pref_get_name
(
pref
);
const
char
*
label
=
purple_plugin_pref_get_label
(
pref
);
if
(
name
==
NULL
)
{
if
(
label
==
NULL
)
continue
;
if
(
purple_plugin_pref_get_pref_type
(
pref
)
==
PURPLE_PLUGIN_PREF_INFO
)
{
make_info_pref
(
parent
,
pref
);
}
else
{
parent
=
pidgin_make_frame
(
ret
,
label
);
gtk_widget_show
(
parent
);
}
continue
;
}
switch
(
purple_prefs_get_pref_type
(
name
))
{
case
PURPLE_PREF_BOOLEAN
:
pidgin_prefs_checkbox
(
label
,
name
,
parent
);
break
;
case
PURPLE_PREF_INT
:
make_int_pref
(
parent
,
pref
,
sg
);
break
;
case
PURPLE_PREF_STRING
:
make_string_pref
(
parent
,
pref
,
sg
);
break
;
default
:
break
;
}
}
g_object_unref
(
sg
);
return
ret
;
}