← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/GtkIconTheme.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:
man/GtkIconTheme.Rd
19
19
\code{\link{gtkIconThemeHasIcon}(object, icon.name)}\cr
20
20
\code{\link{gtkIconThemeLookupIcon}(object, icon.name, size, flags)}\cr
21
21
\code{\link{gtkIconThemeChooseIcon}(object, icon.names, size, flags)}\cr
 
22
\code{\link{gtkIconThemeLookupByGicon}(object, icon, size, flags)}\cr
22
23
\code{\link{gtkIconThemeLoadIcon}(object, icon.name, size, flags, .errwarn = TRUE)}\cr
23
24
\code{\link{gtkIconThemeListContexts}(object)}\cr
24
25
\code{\link{gtkIconThemeListIcons}(object, context = NULL)}\cr
27
28
\code{\link{gtkIconThemeRescanIfNeeded}(object)}\cr
28
29
\code{\link{gtkIconThemeAddBuiltinIcon}(icon.name, size, pixbuf)}\cr
29
30
\code{\link{gtkIconInfoCopy}(object)}\cr
 
31
\code{\link{gtkIconInfoNewForPixbuf}(icon.theme, pixbuf)}\cr
30
32
\code{\link{gtkIconInfoGetBaseSize}(object)}\cr
31
33
\code{\link{gtkIconInfoGetFilename}(object)}\cr
32
34
\code{\link{gtkIconInfoGetBuiltinPixbuf}(object)}\cr
39
41
}
40
42
\section{Hierarchy}{\preformatted{GObject
41
43
   +----GtkIconTheme}}
42
 
\section{Detailed Description}{\verb{\link{GtkIconTheme}} provides a facility for looking up icons by name
 
44
\section{Detailed Description}{\code{\link{GtkIconTheme}} provides a facility for looking up icons by name
43
45
and size. The main reason for using a name rather than simply
44
46
providing a filename is to allow different icons to be used
45
 
depending on what \dfn{icon theme} is selecetd
 
47
depending on what \dfn{icon theme} is selected
46
48
by the user. The operation of icon themes on Linux and Unix
47
49
follows the Icon
48
50
Theme Specification (\url{http://www.freedesktop.org/Standards/icon-theme-spec}). There is a default icon theme,
66
68
\item Because stock images are closely tied to stock items, and thus
67
69
to actions in the user interface, stock images may come in
68
70
multiple variants for different widget states or writing
69
 
directions. 
 
71
directions.
70
72
}  
71
73
A good rule of thumb is that if there is a stock image for what
72
74
you want to use, use it, otherwise use a named icon. It turns
76
78
GTK_STOCK_GO_FORWARD uses the two themed icons
77
79
"gtk-stock-go-forward-ltr" and "gtk-stock-go-forward-rtl".)
78
80
  
79
 
In many cases, named themes are used indirectly, via \verb{\link{GtkImage}}
 
81
In many cases, named themes are used indirectly, via \code{\link{GtkImage}}
80
82
or stock items, rather than directly, but looking up icons
81
 
directly is also simple. The \verb{\link{GtkIconTheme}} object acts
 
83
directly is also simple. The \code{\link{GtkIconTheme}} object acts
82
84
as a database of all the icons in the current theme. You
83
 
can create new \verb{\link{GtkIconTheme}} objects, but its much more
84
 
efficient to use the standard icon theme for the \verb{\link{GdkScreen}}
 
85
can create new \code{\link{GtkIconTheme}} objects, but its much more
 
86
efficient to use the standard icon theme for the \code{\link{GdkScreen}}
85
87
so that the icon information is shared with other people
86
88
looking up icons. In the case where the default screen is
87
89
being used, looking up an icon can be as simple as:
106
108
Normally, you retrieve the icon theme for a particular
107
109
screen using \code{\link{gtkIconThemeGetForScreen}} and it
108
110
will contain information about current icon theme for
109
 
that screen, but you can also create a new \verb{\link{GtkIconTheme}}
 
111
that screen, but you can also create a new \code{\link{GtkIconTheme}}
110
112
object and set the icon theme name explicitely using
111
113
\code{\link{gtkIconThemeSetCustomTheme}}.
112
114
 
115
117
\section{Convenient Construction}{\code{gtkIconTheme} is the equivalent of \code{\link{gtkIconThemeNew}}.}
116
118
\section{Enums and Flags}{\describe{
117
119
\item{\verb{GtkIconLookupFlags}}{
118
 
Used to specify options for \code{\link{gtkIconThemeLookupIcon}}  
 
120
Used to specify options for \code{\link{gtkIconThemeLookupIcon}}
119
121
 
120
122
\describe{
121
 
\item{\verb{no-svg}}{ Never return SVG icons, even if gdk-pixbuf
 
123
\item{\verb{no-svg}}{Never return SVG icons, even if gdk-pixbuf
122
124
  supports them. Cannot be used together with \code{GTK_ICON_LOOKUP_FORCE_SVG}.}
123
 
\item{\verb{force-svg}}{ Return SVG icons, even if gdk-pixbuf
 
125
\item{\verb{force-svg}}{Return SVG icons, even if gdk-pixbuf
124
126
  doesn't support them.
125
127
  Cannot be used together with \code{GTK_ICON_LOOKUP_NO_SVG}.}
126
 
\item{\verb{use-builtin}}{ When passed to
 
128
\item{\verb{use-builtin}}{When passed to
127
129
  \code{\link{gtkIconThemeLookupIcon}} includes builtin icons
128
130
  as well as files. For a builtin icon, \code{\link{gtkIconInfoGetFilename}}
129
131
  returns \code{NULL} and you need to call \code{\link{gtkIconInfoGetBuiltinPixbuf}}.}
131
133
 
132
134
}
133
135
\item{\verb{GtkIconThemeError}}{
134
 
Error codes for GtkIconTheme operations.  
 
136
Error codes for GtkIconTheme operations.
135
137
 
136
138
\describe{
137
 
\item{\verb{not-found}}{ The icon specified does not exist in the theme}
138
 
\item{\verb{failed}}{ An unspecified error occurred.}
 
139
\item{\verb{not-found}}{The icon specified does not exist in the theme}
 
140
\item{\verb{failed}}{An unspecified error occurred.}
139
141
}
140
142
 
141
143
}
143
145
\section{Signals}{\describe{\item{\code{changed(icon.theme, user.data)}}{
144
146
Emitted when the current icon theme is switched or GTK+ detects
145
147
that a change has occurred in the contents of the current
146
 
icon theme.  
 
148
icon theme.
147
149
 
148
150
\describe{
149
 
\item{\code{icon.theme}}{[\verb{\link{GtkIconTheme}}]  the icon theme}
150
 
\item{\code{user.data}}{[R object] user data set when the signal handler was connected.}
 
151
\item{\code{icon.theme}}{the icon theme}
 
152
\item{\code{user.data}}{user data set when the signal handler was connected.}
151
153
}
152
154
 
153
155
 
154
156
}}}
155
 
\references{\url{http://developer.gnome.org/doc/API/2.0/gtk/GtkIconTheme.html}}
 
157
\references{\url{http://library.gnome.org/devel//gtk/GtkIconTheme.html}}
156
158
\author{Derived by RGtkGen from GTK+ documentation}
157
159
\keyword{internal}