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

« back to all changes in this revision

Viewing changes to man/gtkBuilderAddObjectsFromFile.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:
 
1
\alias{gtkBuilderAddObjectsFromFile}
 
2
\name{gtkBuilderAddObjectsFromFile}
 
3
\title{gtkBuilderAddObjectsFromFile}
 
4
\description{Parses a file containing a GtkBuilder 
 
5
UI definition building only the requested objects and merges
 
6
them with the current contents of \code{builder}. }
 
7
\usage{gtkBuilderAddObjectsFromFile(object, filename, object.ids, .errwarn = TRUE)}
 
8
\arguments{
 
9
\item{\verb{object}}{a \code{\link{GtkBuilder}}}
 
10
\item{\verb{filename}}{the name of the file to parse}
 
11
\item{\verb{object.ids}}{array of objects to build}
 
12
\item{.errwarn}{Whether to issue a warning on error or fail silently}
 
13
}
 
14
\details{Upon errors 0 will be returned and \code{error} will be assigned a
 
15
\code{\link{GError}} from the \verb{GTK_BUILDER_ERROR}, \verb{G_MARKUP_ERROR} or \verb{G_FILE_ERROR} 
 
16
domain.
 
17
  \strong{PLEASE NOTE:} If you are adding an object that depends on an object that is not 
 
18
its child (for instance a \code{\link{GtkTreeView}} that depends on its
 
19
\code{\link{GtkTreeModel}}), you have to explicitely list all of them in \code{object.ids}.   Since 2.14}
 
20
\value{
 
21
A list containing the following elements:
 
22
\item{retval}{[numeric]  A positive value on success, 0 if an error occurred}
 
23
\item{\verb{error}}{ return location for an error, or \code{NULL}. \emph{[  \acronym{allow-none}  ]}}
 
24
}
 
25
\note{If you are adding an object that depends on an object that is not 
 
26
its child (for instance a \code{\link{GtkTreeView}} that depends on its
 
27
\code{\link{GtkTreeModel}}), you have to explicitely list all of them in \code{object.ids}. }
 
28
\author{Derived by RGtkGen from GTK+ documentation}
 
29
\keyword{internal}