← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/gtkWidgetGetToplevel.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/gtkWidgetGetToplevel.Rd
6
6
returned as the topmost widget. No reference will be added to the
7
7
returned widget; it should not be unreferenced.}
8
8
\usage{gtkWidgetGetToplevel(object)}
9
 
\arguments{\item{\verb{object}}{[\verb{\link{GtkWidget}}]  a \verb{\link{GtkWidget}}}}
 
9
\arguments{\item{\verb{object}}{a \code{\link{GtkWidget}}}}
10
10
\details{Note the difference in behavior vs. \code{\link{gtkWidgetGetAncestor}};
11
11
\code{gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)} 
12
12
would return
13
13
\code{NULL} if \code{widget} wasn't inside a toplevel window, and if the
14
14
window was inside a \verb{GtkWindow-derived} widget which was in turn
15
 
inside the toplevel \verb{\link{GtkWindow}}. While the second case may
16
 
seem unlikely, it actually happens when a \verb{\link{GtkPlug}} is embedded
17
 
inside a \verb{\link{GtkSocket}} within the same application.
 
15
inside the toplevel \code{\link{GtkWindow}}. While the second case may
 
16
seem unlikely, it actually happens when a \code{\link{GtkPlug}} is embedded
 
17
inside a \code{\link{GtkSocket}} within the same application.
18
18
  
19
 
To reliably find the toplevel \verb{\link{GtkWindow}}, use
 
19
To reliably find the toplevel \code{\link{GtkWindow}}, use
20
20
\code{\link{gtkWidgetGetToplevel}} and check if the \code{TOPLEVEL} flags
21
21
is set on the result.
22
22
\preformatted{
25
25
{
26
26
  # Perform action on toplevel.
27
27
}
28
 
}  }
29
 
\value{[\verb{\link{GtkWidget}}]  the topmost ancestor of \code{widget}, or \code{widget} itself 
30
 
   if there's no ancestor.}
 
28
}}
 
29
\value{[\code{\link{GtkWidget}}]  the topmost ancestor of \code{widget}, or \code{widget} itself
 
30
   if there's no ancestor. \emph{[  \acronym{transfer none}  ]}}
31
31
\author{Derived by RGtkGen from GTK+ documentation}
32
32
\keyword{internal}