← Back to branch summary

~andywingo/guile-gnome/libgnomeui

« back to all changes in this revision

Viewing changes to doc/defuns-gnome-href.xml.texi

  • Committer: Andy Wingo
  • Date: 2007-12-06 16:57:01 UTC
  • Revision ID: wingo@pobox.com-20071206165701-bvgnbf7esiu739gf
2007-12-06  Andy Wingo  <wingo@pobox.com>

        * tests/wrapset.api: Regnerated for massive API removal on
        previous commit.

        * doc/defuns-*.texi: Regenerated.

        * doc/guile-gnome-libgnomeui.texi (Top): 
        * doc/undocumented.texi: New section for undocumented exports.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/defuns-gnome-href.xml.texi
1
1
 
2
2
@c %start of fragment
3
3
 
4
 
@deftp Class <gnome-href>
5
 
This @code{<gobject>} class defines the following properties:
6
 
 
7
 
@table @code
8
 
@item url
9
 
The URL that GnomeHRef activates
10
 
 
11
 
@item text
12
 
The text on the button
13
 
 
14
 
@end table
15
 
 
16
 
@end deftp
17
 
 
18
 
@deffn Function gnome-href-new  (url@tie{}@code{mchars}) (text@tie{}@code{mchars}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
19
 
Created a GNOME href object, a label widget with a clickable action and an
20
 
associated URL. If @var{text} is set to @samp{@code{#f}}, @var{url} is used as
21
 
the text for the label.
22
 
 
23
 
@table @var
24
 
@item url
25
 
URL assigned to this object.
26
 
 
27
 
@item text
28
 
Text associated with the URL.
29
 
 
30
 
@item ret
31
 
Pointer to new GNOME href widget.
32
 
 
33
 
@end table
34
 
 
35
 
@end deffn
36
 
 
37
 
@deffn Function gnome-href-set-url  (self@tie{}@code{<gnome-href>}) (url@tie{}@code{mchars})
38
 
@deffnx Method set-url
39
 
Sets the internal URL value within @var{href} to the value of @var{url}.
40
 
 
41
 
@table @var
42
 
@item href
43
 
Pointer to GnomeHRef widget
44
 
 
45
 
@item url
46
 
String containing the URL to be stored within @var{href}.
47
 
 
48
 
@end table
49
 
 
50
 
@end deffn
51
 
 
52
 
@deffn Function gnome-href-get-url  (self@tie{}@code{<gnome-href>}) @result{}@tie{} (ret@tie{}@code{mchars})
53
 
@deffnx Method get-url
54
 
Returns the pointer to the URL associated with the @var{href} href object. Note
55
 
that the string should not be freed as it is internal memory.
56
 
 
57
 
@table @var
58
 
@item href
59
 
Pointer to GnomeHRef widget
60
 
 
61
 
@item ret
62
 
Pointer to an internal URL string, or @samp{@code{#f}} if failure.
63
 
 
64
 
@end table
65
 
 
66
 
@end deffn
67
 
 
68
 
@deffn Function gnome-href-set-text  (self@tie{}@code{<gnome-href>}) (text@tie{}@code{mchars})
69
 
@deffnx Method set-text
70
 
Sets the internal label widget text (used to display a URL's link text) to the
71
 
value given in @var{label}.
72
 
 
73
 
@table @var
74
 
@item href
75
 
Pointer to GnomeHRef widget
76
 
 
77
 
@item text
78
 
New link text for the href object.
79
 
 
80
 
@end table
81
 
 
82
 
@end deffn
83
 
 
84
 
@deffn Function gnome-href-get-text  (self@tie{}@code{<gnome-href>}) @result{}@tie{} (ret@tie{}@code{mchars})
85
 
@deffnx Method get-text
86
 
Returns the contents of the label widget used to display the link text. Note
87
 
that the string should not be freed as it points to internal memory.
88
 
 
89
 
@table @var
90
 
@item href
91
 
Pointer to GnomeHRef widget
92
 
 
93
 
@item ret
94
 
Pointer to text contained in the label widget.
95
 
 
96
 
@end table
97
 
 
98
 
@end deffn
99
 
 
100
4
 
101
5
@c %end of fragment