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

« back to all changes in this revision

Viewing changes to man/gtkEditableGetSelectionBounds.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
1
\alias{gtkEditableGetSelectionBounds}
2
2
\name{gtkEditableGetSelectionBounds}
3
3
\title{gtkEditableGetSelectionBounds}
4
 
\description{Gets the current selection bounds, if there is a selection.}
 
4
\description{Retrieves the selection bound of the editable. start_pos will be filled
 
5
with the start of the selection and \code{end.pos} with end. If no text was
 
6
selected both will be identical and \code{FALSE} will be returned.}
5
7
\usage{gtkEditableGetSelectionBounds(object)}
6
 
\arguments{\item{\verb{object}}{[\verb{\link{GtkEditable}}] a \verb{\link{GtkEditable}} widget.}}
 
8
\arguments{\item{\verb{object}}{a \code{\link{GtkEditable}}}}
 
9
\details{Note that positions are specified in characters, not bytes.}
7
10
\value{
8
11
A list containing the following elements:
9
 
\item{retval}{[logical] \code{TRUE} if there is a selection.}
10
 
\item{\verb{start}}{[integer] location to store the starting position, or \code{NULL}.}
11
 
\item{\verb{end}}{[integer] location to store the end position, or \code{NULL}.}
 
12
\item{retval}{[logical] \code{TRUE} if an area is selected, \code{FALSE} otherwise}
 
13
\item{\verb{start}}{ location to store the starting position, or \code{NULL}. \emph{[  \acronym{out}  ][  \acronym{allow-none}  ]}}
 
14
\item{\verb{end}}{ location to store the end position, or \code{NULL}. \emph{[  \acronym{out}  ][  \acronym{allow-none}  ]}}
12
15
}
13
16
\author{Derived by RGtkGen from GTK+ documentation}
14
17
\keyword{internal}