~ubuntu-branches/ubuntu/trusty/rgtk2/trusty

« back to all changes in this revision

Viewing changes to man/GtkLinkButton.Rd

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2010-11-03 11:35:46 UTC
  • mfrom: (1.3.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20101103113546-a7fi7jdxdebp0tw1
Tags: 2.20.1-1
* New upstream release

* debian/control: Set (Build-)Depends: to current R version
* debian/control: Set Standards-Version: to current version 

Show diffs side-by-side

added added

removed removed

Lines of Context:
10
10
\code{\link{gtkLinkButtonGetUri}(object)}\cr
11
11
\code{\link{gtkLinkButtonSetUri}(object, uri)}\cr
12
12
\code{\link{gtkLinkButtonSetUriHook}(func, data)}\cr
 
13
\code{\link{gtkLinkButtonGetVisited}(object)}\cr
 
14
\code{\link{gtkLinkButtonSetVisited}(object, visited)}\cr
13
15
\code{gtkLinkButton(uri, label = NULL, show = TRUE)}
14
16
}
15
17
\section{Hierarchy}{\preformatted{GObject
21
23
                                 +----GtkButton
22
24
                                       +----GtkLinkButton}}
23
25
\section{Interfaces}{GtkLinkButton implements
24
 
 AtkImplementorIface and  \verb{\link{GtkBuildable}}.}
25
 
\section{Detailed Description}{A \verb{\link{GtkLinkButton}} is a \verb{\link{GtkButton}} with a hyperlink, similar to the one
 
26
 AtkImplementorIface,  \code{\link{GtkBuildable}} and  \code{\link{GtkActivatable}}.}
 
27
\section{Detailed Description}{A \code{\link{GtkLinkButton}} is a \code{\link{GtkButton}} with a hyperlink, similar to the one
26
28
used by web browsers, which triggers an action when clicked. It is useful
27
29
to show quick links to resources.
28
30
  
30
32
\code{\link{gtkLinkButtonNewWithLabel}}. If using the former, the URI you pass
31
33
to the constructor is used as a label for the widget.
32
34
  
33
 
The URI bound to a \verb{\link{GtkLinkButton}} can be set specifically using
 
35
The URI bound to a \code{\link{GtkLinkButton}} can be set specifically using
34
36
\code{\link{gtkLinkButtonSetUri}}, and retrieved using \code{\link{gtkLinkButtonGetUri}}.
35
 
  \verb{\link{GtkLinkButton}} offers a global hook, which is called when the used clicks
 
37
  \code{\link{GtkLinkButton}} offers a global hook, which is called when the used clicks
36
38
on it: see \code{\link{gtkLinkButtonSetUriHook}}.
37
 
  \verb{\link{GtkLinkButton}} was added in GTK+ 2.10.}
 
39
  \code{\link{GtkLinkButton}} was added in GTK+ 2.10.}
38
40
\section{Structures}{\describe{\item{\verb{GtkLinkButton}}{
39
 
The \verb{\link{GtkLinkButton}} struct contains private data only, and should be
 
41
The \code{\link{GtkLinkButton}} struct contains private data only, and should be
40
42
manipulated using the functions below.
41
43
 
42
44
}}}
43
45
\section{Convenient Construction}{\code{gtkLinkButton} is the equivalent of \code{\link{gtkLinkButtonNewWithLabel}}.}
44
46
\section{User Functions}{\describe{\item{\code{GtkLinkButtonUriFunc(button, link., user.data)}}{
45
 
The type of a function which is called when the \verb{\link{GtkLinkButton}} is
 
47
The type of a function which is called when the \code{\link{GtkLinkButton}} is
46
48
clicked.
47
49
 
48
50
\describe{
49
 
\item{\code{button}}{[\verb{\link{GtkLinkButton}}] the \verb{\link{GtkLinkButton}} which was clicked}
50
 
\item{\code{link.}}{[character] }
51
 
\item{\code{user.data}}{[R object] user data that was passed when the function was registered
 
51
\item{\code{button}}{the \code{\link{GtkLinkButton}} which was clicked}
 
52
\item{\code{link.}}{the URI to which the clicked \code{\link{GtkLinkButton}} points}
 
53
\item{\code{user.data}}{user data that was passed when the function was registered
52
54
  with \code{\link{gtkLinkButtonSetUriHook}}}
53
55
}
54
56
 
55
57
 
56
58
}}}
57
 
\section{Properties}{\describe{\item{\verb{uri} [character : *                : Read / Write]}{
58
 
 
59
 
The URI bound to this button.  
60
 
 
61
 
  Default value: "http://www.gtk.org"  Since  2.10
62
 
 
63
 
}}}
64
 
\references{\url{http://developer.gnome.org/doc/API/2.0/gtk/GtkLinkButton.html}}
 
59
\section{Properties}{\describe{
 
60
\item{\verb{uri} [character : *                : Read / Write]}{
 
61
 
 
62
The URI bound to this button.
 
63
  Default value: NULL  Since 2.10
 
64
 
 
65
}
 
66
\item{\verb{visited} [logical : Read / Write]}{
 
67
 
 
68
The 'visited' state of this button. A visited link is drawn in a
 
69
different color.
 
70
  Default value: FALSE  Since 2.14
 
71
 
 
72
}
 
73
}}
 
74
\references{\url{http://library.gnome.org/devel//gtk/GtkLinkButton.html}}
65
75
\author{Derived by RGtkGen from GTK+ documentation}
66
 
\seealso{\verb{\link{GtkButton}}}
 
76
\seealso{\code{\link{GtkButton}}}
67
77
\keyword{internal}