RGtk2 (version 2.8.8)

RGtkObject: The base object of RGtk2

Description

RGtkObject identifies an external object as being owned by RGtk. Practically, it allows convenience operators to be specified for any external object.

Usage

"[[.RGtkObject"(x, field)
"$.RGtkObject"(x, method)
"==.RGtkObject"(x, y)

Arguments

x

The RGtkObject to which the method or field belongs or the left hand of a comparison

field

The name of the field whose value will be retrieved

method

The name of the method that will be expanded to a function

y

The right hand operand of a comparison

Value

• A context-dependent value resulting from the specified API call.

Details

The operators [[ and $ both expand to an RGtk function that accesses external objects. The [[ operator retrieves a field value from an external structure by expanding objectOfClassName[[fieldName]] to classNameGetFieldName(). External "methods" are expanded by the $ operator to form classNameMethodName(objectOfClassName, ...) from the Java-like objectOfClassName$methodName(...). The long and short mechanisms give the same result, but the shortcut is obviously more convenient.

The == operator compares two RGtkObjects on the basis of their internal pointer value. This should rarely be useful for users.