GtkWidget {RGtk2} | R Documentation |
Base class for all widgets
gtkWidgetNew(type, ..., show = TRUE)
gtkWidgetDestroy(object, ...)
gtkWidgetSet(obj, ...)
gtkWidgetUnparent(object)
gtkWidgetShow(object)
gtkWidgetShowNow(object)
gtkWidgetHide(object)
gtkWidgetShowAll(object)
gtkWidgetHideAll(object)
gtkWidgetMap(object)
gtkWidgetUnmap(object)
gtkWidgetRealize(object)
gtkWidgetUnrealize(object)
gtkWidgetQueueDraw(object)
gtkWidgetQueueResize(object)
gtkWidgetQueueResizeNoRedraw(object)
gtkWidgetDraw(object, area)
gtkWidgetSizeRequest(object)
gtkWidgetGetChildRequisition(object)
gtkWidgetSizeAllocate(object, allocation)
gtkWidgetAddAccelerator(object, accel.signal, accel.group, accel.key, accel.mods, accel.flags)
gtkWidgetRemoveAccelerator(object, accel.group, accel.key, accel.mods)
gtkWidgetSetAccelPath(object, accel.path, accel.group)
gtkWidgetListAccelClosures(object)
gtkWidgetCanActivateAccel(object, signal.id)
gtkWidgetEvent(object, event)
gtkWidgetActivate(object)
gtkWidgetReparent(object, new.parent)
gtkWidgetIntersect(object, area, intersection)
gtkWidgetIsFocus(object)
gtkWidgetGrabFocus(object)
gtkWidgetGrabDefault(object)
gtkWidgetSetName(object, name)
gtkWidgetGetName(object)
gtkWidgetSetState(object, state)
gtkWidgetSetSensitive(object, sensitive)
gtkWidgetSetParent(object, parent)
gtkWidgetSetParentWindow(object, parent.window)
gtkWidgetGetParentWindow(object)
gtkWidgetSetUposition(object, x, y)
gtkWidgetSetUsize(object, width, height)
gtkWidgetSetEvents(object, events)
gtkWidgetAddEvents(object, events)
gtkWidgetSetExtensionEvents(object, mode)
gtkWidgetGetExtensionEvents(object)
gtkWidgetGetToplevel(object)
gtkWidgetGetAncestor(object, widget.type)
gtkWidgetGetColormap(object)
gtkWidgetSetColormap(object, colormap)
gtkWidgetGetVisual(object)
gtkWidgetGetEvents(object)
gtkWidgetGetPointer(object)
gtkWidgetIsAncestor(object, ancestor)
gtkWidgetTranslateCoordinates(object, dest.widget, src.x, src.y)
gtkWidgetHideOnDelete(object)
gtkWidgetSetStyle(object, style = NULL)
gtkWidgetEnsureStyle(object)
gtkWidgetGetStyle(object)
gtkWidgetResetRcStyles(object)
gtkWidgetPushColormap(cmap)
gtkWidgetPopColormap()
gtkWidgetSetDefaultColormap(colormap)
gtkWidgetGetDefaultStyle()
gtkWidgetGetDefaultColormap()
gtkWidgetGetDefaultVisual()
gtkWidgetSetDirection(object, dir)
gtkWidgetGetDirection(object)
gtkWidgetSetDefaultDirection(dir)
gtkWidgetGetDefaultDirection()
gtkWidgetShapeCombineMask(object, shape.mask, offset.x, offset.y)
gtkWidgetInputShapeCombineMask(object, shape.mask = NULL, offset.x, offset.y)
gtkWidgetPath(object)
gtkWidgetClassPath(object)
gtkWidgetGetCompositeName(object)
gtkWidgetModifyStyle(object, style)
gtkWidgetGetModifierStyle(object)
gtkWidgetModifyFg(object, state, color = NULL)
gtkWidgetModifyBg(object, state, color = NULL)
gtkWidgetModifyText(object, state, color = NULL)
gtkWidgetModifyBase(object, state, color = NULL)
gtkWidgetModifyFont(object, font.desc = NULL)
gtkWidgetModifyCursor(object, primary, secondary)
gtkWidgetCreatePangoContext(object)
gtkWidgetGetPangoContext(object)
gtkWidgetCreatePangoLayout(object, text)
gtkWidgetRenderIcon(object, stock.id, size, detail = NULL)
gtkWidgetPopCompositeChild()
gtkWidgetPushCompositeChild()
gtkWidgetQueueClear(object)
gtkWidgetQueueClearArea(object, x, y, width, height)
gtkWidgetQueueDrawArea(object, x, y, width, height)
gtkWidgetResetShapes(object)
gtkWidgetSetAppPaintable(object, app.paintable)
gtkWidgetSetDoubleBuffered(object, double.buffered)
gtkWidgetSetRedrawOnAllocate(object, redraw.on.allocate)
gtkWidgetSetCompositeName(object, name)
gtkWidgetSetScrollAdjustments(object, hadjustment = NULL, vadjustment = NULL)
gtkWidgetMnemonicActivate(object, group.cycling)
gtkWidgetClassInstallStyleProperty(klass, pspec)
gtkWidgetClassInstallStylePropertyParser(klass, pspec, parser)
gtkWidgetClassFindStyleProperty(klass, property.name)
gtkWidgetClassListStyleProperties(klass)
gtkWidgetRegionIntersect(object, region)
gtkWidgetSendExpose(object, event)
gtkWidgetStyleGet(object, ...)
gtkWidgetStyleGetProperty(object, property.name)
gtkWidgetGetAccessible(object)
gtkWidgetChildFocus(object, direction)
gtkWidgetChildNotify(object, child.property)
gtkWidgetFreezeChildNotify(object)
gtkWidgetGetChildVisible(object)
gtkWidgetGetParent(object)
gtkWidgetGetSettings(object)
gtkWidgetGetClipboard(object, selection)
gtkWidgetGetDisplay(object)
gtkWidgetGetRootWindow(object)
gtkWidgetGetScreen(object)
gtkWidgetHasScreen(object)
gtkWidgetGetSizeRequest(object)
gtkWidgetSetChildVisible(object, is.visible)
gtkWidgetSetSizeRequest(object, width, height)
gtkWidgetThawChildNotify(object)
gtkWidgetSetNoShowAll(object, no.show.all)
gtkWidgetGetNoShowAll(object)
gtkWidgetListMnemonicLabels(object)
gtkWidgetAddMnemonicLabel(object, label)
gtkWidgetRemoveMnemonicLabel(object, label)
gtkWidgetGetAction(object)
gtkWidgetIsComposited(object)
gtkWidgetErrorBell(object)
gtkWidgetKeynavFailed(object, direction)
gtkWidgetGetTooltipMarkup(object)
gtkWidgetSetTooltipMarkup(object, markup)
gtkWidgetGetTooltipText(object)
gtkWidgetSetTooltipText(object, text)
gtkWidgetGetTooltipWindow(object)
gtkWidgetSetTooltipWindow(object, custom.window)
gtkWidgetGetHasTooltip(object)
gtkWidgetSetHasTooltip(object, has.tooltip)
gtkWidgetTriggerTooltipQuery(object)
gtkRequisitionCopy(object)
gtkWidget(type, ..., show = TRUE)
GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkContainer +----GtkMisc +----GtkCalendar +----GtkCellView +----GtkDrawingArea +----GtkEntry +----GtkRuler +----GtkRange +----GtkSeparator +----GtkInvisible +----GtkOldEditable +----GtkPreview +----GtkProgress
GtkWidget implements
GtkBuildable
and AtkImplementorIface.
GtkWidget is required by
GtkFileChooser
and GtkCellEditable
.
GtkWidget
introduces style
properties - these are basically object properties that are stored
not on the object, but in the style object associated to the widget. Style
properties are set in resource files.
This mechanism is used for configuring such things as the location of the
scrollbar arrows through the theme, giving theme authors more control over the
look of applications without the need to write a theme engine in C.
Use gtkWidgetClassInstallStyleProperty
to install style properties for
a widget class, gtkWidgetClassFindStyleProperty
or
gtkWidgetClassListStyleProperties
to get information about existing
style properties and gtkWidgetStyleGetProperty
, gtkWidgetStyleGet
or
gtkWidgetStyleGetValist()
to obtain the value of a style property.
The GtkWidget implementation of the GtkBuildable interface supports a custom <accelerator> element, which has attributes named key, modifiers and signal and allows to specify accelerators.
A UI definition fragment specifying an accelerator
<object class="GtkButton"> <accelerator key="q" modifiers="GDK_CONTROL_MASK" signal="clicked"/> </object>
GtkWidget
style
GtkStyle
] The style for the widget. The style contains the colors the widget should be
drawn in for each state along with graphics contexts used to draw with and the font
to use for text.requisition
GtkRequisition
] The widget's desired size.allocation
GtkAllocation
] The widget's allocated size.window
GdkWindow
] The widget's window or its parent window if it does not have a window. (Which
will be indicated by the GTK_NO_WINDOW
flag being set).parent
GtkWidget
]
GtkWidgetClass
activate_signal
The signal to emit when a widget of this class is activated,
gtkWidgetActivate
handles the emission. Implementation of this
signal is optional.
set_scroll_adjustment_signal
This signal is emitted when a widget of this class is added
to a scrolling aware parent, gtkWidgetSetScrollAdjustments
handles the emission.
Implementation of this signal is optional.
GtkRequisition
GtkRequisition
represents the desired size of a widget. See
for more information.
width
height
GtkSelectionData
selection
GdkAtom
] target
GdkAtom
] type
GdkAtom
] format
data
gtkWidget
is the equivalent of gtkWidgetNew
.
GtkWidgetFlags
toplevel
GtkWindow
s and
GtkMenu
s have this flag set throughout their lifetime.
Toplevel widgets always contain their own GdkWindow
.no-window
GdkWindow
.
Visible action (e.g. drawing) is performed on the parent's GdkWindow
.realized
gtkWidgetRealize
, unset by gtkWidgetUnrealize
.
A realized widget has an associated GdkWindow
.mapped
gtkWidgetMap
, unset by gtkWidgetUnmap
.
Only realized widgets can be mapped. It means that gdkWindowShow
has been called on the widgets window(s).visible
gtkWidgetShow
, unset by gtkWidgetHide
. Implies that a
widget will be mapped as soon as its parent is mapped.sensitive
gtkWidgetSetSensitive
.
The sensitivity of a widget determines whether it will receive
certain events (e.g. button or key presses). One premise for
the widget's sensitivity is to have this flag set.parent-sensitive
gtkWidgetSetSensitive
operations on the
parents of the widget.
This is the second premise for the widget's sensitivity. Once
it has GTK_SENSITIVE
and GTK_PARENT_SENSITIVE
set, its state is
effectively sensitive. This is expressed (and can be examined) by
the GTK_WIDGET_IS_SENSITIVE
function.can-focus
has-focus
gtkWidgetGrabFocus
for widgets that also
have GTK_CAN_FOCUS
set. The flag will be unset once another widget
grabs the focus.can-default
gtkWidgetGrabDefault
.has-default
has-grab
gtkGrabAdd
, unset by gtkGrabRemove
. It means that the
widget is in the grab_widgets stack, and will be the preferred one for
receiving events other than ones of cosmetic value.rc-style
composite-child
gtkWidgetPushCompositeChild
, gtkWidgetPopCompositeChild
.no-reparent
app-paintable
gtkWidgetSetAppPaintable
.
Must be set on widgets whose window the application directly draws on,
in order to keep GTK+ from overwriting the drawn stuff.receives-default
GTK_HAS_DEFAULT
set even if there is a different widget set as default.double-buffered
gtkWidgetSetDoubleBuffered
.
Indicates that exposes done on the widget should be double-buffered.no-show-all
GtkWidgetHelpType
tooltip
whats-this
GtkTextDirection
none
ltr
rtl
GtkCallback(widget, data)
gtkContainerForeach
.
widget
GtkWidget
] the widget to operate ondata
The (widget, user.data)
widget
GtkWidget
] the object which received the signal.user.data
The (widget, event, user.data)
To receive this signal, the GdkWindow
associated to the
widget needs to enable the GDK_BUTTON_PRESS_MASK
mask.
This signal will be sent to the grab widget if there is one.
widget
GtkWidget
] the object which received the signal.event
GdkEventButton
] the GdkEventButton
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, event, user.data)
To receive this signal, the GdkWindow
associated to the
widget needs to enable the GDK_BUTTON_RELEASE_MASK
mask.
This signal will be sent to the grab widget if there is one.
widget
GtkWidget
] the object which received the signal.event
GdkEventButton
] the GdkEventButton
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, signal.id, user.data)
signal.id
can currently be activated.
This signal is present to allow applications and derived
widgets to override the default GtkWidget
handling
for determining whether an accelerator can be activated.
widget
GtkWidget
] the object which received the signalsignal.id
widget
user.data
Returns: [logical] TRUE
if the signal can be activated.
The (widget, pspec, user.data)
widget
GtkWidget
] the object which received the signalpspec
GParamSpec
] the GParamSpec
of the changed child propertyuser.data
The (widget, event, user.data)
widget
's window
receives a message (via a ClientMessage event) from another
application.
widget
GtkWidget
] the object which received the signalevent
GdkEventClient
] the GdkEventClient
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for
the event. FALSE
to propagate the event further.
The (widget, user.data)
widget
s screen changes.
See gdkScreenIsComposited
.
widget
GtkWidget
] the object on which the signal is emitteduser.data
The (widget, event, user.data)
widget
's window has changed.
To receive this signal, the GdkWindow
associated to the widget needs
to enable the GDK_STRUCTURE_MASK
mask. GDK will enable this mask
automatically for all new windows.
widget
GtkWidget
] the object which received the signalevent
GdkEventConfigure
] the GdkEventConfigure
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, event, user.data)
gtkWidgetHideOnDelete
to
this signal will cause the window to be hidden instead, so that
it can later be shown again without reconstructing it.
widget
GtkWidget
] the object which received the signalevent
GdkEvent
] the event which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, event, user.data)
GdkWindow
is destroyed.
You rarely get this signal, because most widgets disconnect themselves
from their window before they destroy it, so no widget owns the
window at destroy time.
To receive this signal, the GdkWindow
associated to the widget needs
to enable the GDK_STRUCTURE_MASK
mask. GDK will enable this mask
automatically for all new windows.
widget
GtkWidget
] the object which received the signal.event
GdkEvent
] the event which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, previous.direction, user.data)
widget
GtkWidget
] the object on which the signal is emittedprevious.direction
GtkTextDirection
] the previous text direction of widget
user.data
The (widget, drag.context, user.data)
gtkDragSourceSetIcon
.
widget
GtkWidget
] the object which received the signaldrag.context
GdkDragContext
] the drag contextuser.data
The (widget, drag.context, user.data)
GDK_ACTION_MOVE
is successfully completed. The signal
handler is responsible for deleting the data that has been dropped. What
"delete" means depends on the context of the drag operation.
widget
GtkWidget
] the object which received the signaldrag.context
GdkDragContext
] the drag contextuser.data
The (widget, drag.context, data, info, time, user.data)
data
with the data in the format which
is indicated by info
. See gtkSelectionDataSet
and
gtkSelectionDataSetText
.
widget
GtkWidget
] the object which received the signaldrag.context
GdkDragContext
] the drag contextdata
GtkSelectionData
] the GtkSelectionData
to be filled with the dragged datainfo
GtkTargetList
time
user.data
The (widget, drag.context, x, y, data, info, time, user.data)
gdkDragStatus
and not finish the drag.
If the data was received in response to a ::drag-drop
signal
(and this is the last target to be received), the handler for this
signal is expected to process the received data and then call
gtkDragFinish
, setting the success
parameter depending on whether
the data was processed successfully.
The handler may inspect and modify drag.context->action
before calling
gtkDragFinish
, e.g. to implement GDK_ACTION_ASK
as shown in the
following example:
drag_data_received <- function(widget, drag_context, x, y, data, info, time) { if ((data[["length"]] >= 0) && (data[["format"]] == 8)) { if (drag_context[["action"]] == "ask") { dialog <- gtkMessageDialog(NULL, c("modal", "destroy-with-parent"), "info", "yes-no", "Move the data ?") response <- dialog$run() dialog$destroy() gtkDragFinish(drag_context, TRUE, response == "yes", time) } } else gtkDragFinish(drag_context, FALSE, FALSE, time) }
widget
GtkWidget
] the object which received the signaldrag.context
GdkDragContext
] the drag contextx
y
data
GtkSelectionData
] the received datainfo
GtkTargetList
time
user.data
The (widget, drag.context, x, y, time, returns, user.data)
FALSE
and no further processing is necessary.
Otherwise, the handler returns TRUE
. In this case, the handler must
ensure that gtkDragFinish
is called to let the source know that
the drop is done. The call to gtkDragFinish
can be done either
directly or in a ::drag-data-received
handler which gets
triggered by calling gtkDragGetData
to receive the data for one
or more of the supported targets.
widget
GtkWidget
] the object which received the signaldrag.context
GdkDragContext
] the drag contextx
y
time
returns
user.data
The (widget, drag.context, user.data)
::drag-begin
.
widget
GtkWidget
] the object which received the signaldrag.context
GdkDragContext
] the drag contextuser.data
The (widget, drag.context, result, user.data)
TRUE
is the failure has
been already handled (not showing the default "drag operation failed"
animation), otherwise it returns FALSE
.
Since 2.12
widget
GtkWidget
] the object which received the signaldrag.context
GdkDragContext
] the drag contextresult
user.data
Returns: [logical] TRUE
if the failed drag operation has been already handled.
The (widget, drag.context, time, user.data)
::drag-motion
, e.g. undo highlighting
with gtkDragUnhighlight
widget
GtkWidget
] the object which received the signal.drag.context
GdkDragContext
] the drag contexttime
user.data
The (widget, drag.context, x, y, time, returns, user.data)
FALSE
and no further processing
is necessary. Otherwise, the handler returns TRUE
. In this case, the
handler is responsible for providing the necessary information for
displaying feedback to the user, by calling gdkDragStatus
. If the
decision whether the drop will be accepted or rejected can't be made
based solely on the cursor position and the type of the data, the handler
may inspect the dragged data by calling gtkDragGetData
and defer the
gdkDragStatus
call to the ::drag-data-received
handler.
Note that there is no drag-enter signal. The drag receiver has to keep
track of whether he has received any drag-motion signals since the last
::drag-leave
and if not, treat the drag-motion signal as an
"enter" signal. Upon an "enter", the handler will typically highlight
the drop site with gtkDragHighlight
.
drag_motion <- function(widget, context, x, y, time) { state <- widget$getData("drag-state") if (!state$drag_highlight) { state$drag_highlight <- T gtkDragHighlight(widget) } target <- gtkDragDestFindTarget(widget, context, NULL) if (target == 0) gdkDragStatus(context, 0, time) else { state$pending_status <- context[["suggestedAction"]] gtkDragGetData(widget, context, target, time) } widget$setData("drag-state", state) return(TRUE) } drag_data_received <- function(widget, context, x, y, selection_data, info, time) { state <- widget$getData("drag-state") if (state$pending_status) { # We are getting this data due to a request in drag_motion, # rather than due to a request in drag_drop, so we are just # supposed to call gdk_drag_status(), not actually paste in the data. str <- gtkSelectionDataGetText(selection_data) if (!data_is_acceptable (str)) gdkDragStatus(context, 0, time) else gdkDragStatus(context, state$pending_status, time) state$pending_status <- 0 } else { # accept the drop } widget$setData("drag-state", state) }
widget
GtkWidget
] the object which received the signaldrag.context
GdkDragContext
] the drag contextx
y
time
returns
user.data
The (widget, event, user.data)
widget
's window.
To receive this signal, the GdkWindow
associated to the widget needs
to enable the GDK_ENTER_NOTIFY_MASK
mask.
This signal will be sent to the grab widget if there is one.
widget
GtkWidget
] the object which received the signalevent
GdkEventCrossing
] the GdkEventCrossing
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, event, user.data)
::key-press-event
) and finally a generic
::event-after
signal.
widget
GtkWidget
] the object which received the signal.event
GdkEvent
] the GdkEvent
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event
and to cancel the emission of the second specific ::event signal.
FALSE
to propagate the event further and to allow the emission of
the second signal. The ::event-after signal is emitted regardless of
the return value.
The (widget, event, user.data)
gtkWidgetEvent
signal and (optionally)
the second more specific signal, ::event-after will be emitted
regardless of the previous two signals handlers return values.
widget
GtkWidget
] the object which received the signal.event
GdkEvent
] the GdkEvent
which triggered this signaluser.data
The (widget, event, user.data)
GdkWindow
is made visible and needs to be redrawn.
GTK_NO_WINDOW
widgets will get a synthesized event from their parent
widget.
To receive this signal, the GdkWindow
associated to the widget needs
to enable the GDK_EXPOSURE_MASK
mask.
widget
GtkWidget
] the object which received the signal.event
GdkEventExpose
] the GdkEventExpose
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, arg1, user.data)
widget
GtkWidget
] the object which received the signal.arg1
GtkDirectionType
] user.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event. FALSE
to propagate the event further.
The (widget, event, user.data)
widget
's window.
To receive this signal, the GdkWindow
associated to the widget needs
to enable the GDK_FOCUS_CHANGE_MASK
mask.
widget
GtkWidget
] the object which received the signalevent
GdkEventFocus
] the GdkEventFocus
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, event, user.data)
widget
's window.
To receive this signal, the GdkWindow
associated to the widget needs
to enable the GDK_FOCUS_CHANGE_MASK
mask.
widget
GtkWidget
] the object which received the signalevent
GdkEventFocus
] the GdkEventFocus
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, event, user.data)
widget
gets broken.
On X11, this happens when the grab window becomes unviewable (i.e. it or one of its ancestors is unmapped), or if the same application grabs the pointer or keyboard again.
Since 2.8
widget
GtkWidget
] the object which received the signalevent
GdkEvent
] the GdkEventGrabBroken
eventuser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for
the event. FALSE
to propagate the event further.
The (widget, user.data)
widget
GtkWidget
] the object which received the signal.user.data
The (widget, was.grabbed, user.data)
A widget is shadowed by a gtkGrabAdd
when the topmost
grab widget in the grab stack of its window group is not
its ancestor.
widget
GtkWidget
] the object which received the signalwas.grabbed
FALSE
if the widget becomes shadowed, TRUE
if it becomes unshadoweduser.data
The (widget, user.data)
widget
GtkWidget
] the object which received the signal.user.data
The (widget, previous.toplevel, user.data)
GtkWindow
. This signal is emitted when
a widget changes from un-anchored to anchored or vice-versa.
widget
GtkWidget
] the object on which the signal is emittedprevious.toplevel
GtkWidget
] the previous toplevel ancestor, or NULL
if the widget was previously unanchoreduser.data
The (widget, event, user.data)
To receive this signal, the GdkWindow
associated to the widget needs
to enable the GDK_KEY_PRESS_MASK
mask.
This signal will be sent to the grab widget if there is one.
widget
GtkWidget
] the object which received the signalevent
GdkEventKey
] the GdkEventKey
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, event, user.data)
To receive this signal, the GdkWindow
associated to the widget needs
to enable the GDK_KEY_RELEASE_MASK
mask.
This signal will be sent to the grab widget if there is one.
widget
GtkWidget
] the object which received the signalevent
GdkEventKey
] the GdkEventKey
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, direction, user.data)
gtkWidgetKeynavFailed
for details.
Since 2.12
widget
GtkWidget
] the object which received the signaldirection
GtkDirectionType
] the direction of movementuser.data
Returns: [logical] TRUE
if stopping keyboard navigation is fine, FALSE
if the emitting widget should try to handle the keyboard
navigation attempt in its parent container(s).
The (widget, event, user.data)
widget
's window.
To receive this signal, the GdkWindow
associated to the widget needs
to enable the GDK_LEAVE_NOTIFY_MASK
mask.
This signal will be sent to the grab widget if there is one.
widget
GtkWidget
] the object which received the signalevent
GdkEventCrossing
] the GdkEventCrossing
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, user.data)
widget
GtkWidget
] the object which received the signal.user.data
The (widget, event, user.data)
widget
's window is
mapped. A window is mapped when it becomes visible on the screen.
To receive this signal, the GdkWindow
associated to the widget needs
to enable the GDK_STRUCTURE_MASK
mask. GDK will enable this mask
automatically for all new windows.
widget
GtkWidget
] the object which received the signalevent
GdkEvent
] the GdkEventAny
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, arg1, user.data)
widget
GtkWidget
] the object which received the signal.arg1
user.data
The (widget, event, user.data)
GdkWindow
.
To receive this signal, the GdkWindow
associated to the widget
needs to enable the GDK_POINTER_MOTION_MASK
mask.
This signal will be sent to the grab widget if there is one.
widget
GtkWidget
] the object which received the signal.event
GdkEventMotion
] the GdkEventMotion
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, arg1, user.data)
widget
GtkWidget
] the object which received the signal.arg1
GtkDirectionType
] user.data
The (widget, event, user.data)
widget
's window is
drawn as a copy of another GdkDrawable
(with gdkDrawDrawable
or
gdkWindowCopyArea()
) which was completely unobscured. If the source
window was partially obscured GdkEventExpose
events will be generated
for those areas.
widget
GtkWidget
] the object which received the signalevent
GdkEventNoExpose
] the GdkEventNoExpose
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, old.parent, user.data)
widget
GtkWidget
] the object on which the signal is emittedold.parent
GtkObject
] the previous parent, or NULL
if the widget
just got its initial parent.user.data
The (widget, user.data)
GtkEntry
widget creates
a menu with clipboard commands. See
for an example of how to use this signal.
widget
GtkWidget
] the object which received the signaluser.data
Returns: [logical] TRUE
if a menu was activated
The (widget, event, user.data)
widget
's window has been changed or deleted.
To receive this signal, the GdkWindow
associated to the widget needs
to enable the GDK_PROPERTY_CHANGE_MASK
mask.
widget
GtkWidget
] the object which received the signalevent
GdkEventProperty
] the GdkEventProperty
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, event, user.data)
GdkWindow
associated to the widget needs
to enable the GDK_PROXIMITY_IN_MASK
mask.
This signal will be sent to the grab widget if there is one.
widget
GtkWidget
] the object which received the signalevent
GdkEventProximity
] the GdkEventProximity
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, event, user.data)
GdkWindow
associated to the widget needs
to enable the GDK_PROXIMITY_OUT_MASK
mask.
This signal will be sent to the grab widget if there is one.
widget
GtkWidget
] the object which received the signalevent
GdkEventProximity
] the GdkEventProximity
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, x, y, keyboard.mode, tooltip, user.data)
:gtk-tooltip-timeout
has expired with
the cursor hovering "above" widget
; or emitted when widget
got
focus in keyboard mode.
Using the given coordinates, the signal handler should determine
whether a tooltip should be shown for widget
. If this is the case
TRUE
should be returned, FALSE
otherwise. Note that if
keyboard.mode
is TRUE
, the values of x
and y
are undefined and
should not be used.
The signal handler is free to manipulate tooltip
with the therefore
destined function calls.
Since 2.12
widget
GtkWidget
] the object which received the signalx
widget->window
y
widget->window
keyboard.mode
TRUE
if the tooltip was trigged using the keyboardtooltip
GtkTooltip
] a GtkTooltip
user.data
Returns: [logical] TRUE
if tooltip
should be shown right now, FALSE
otherwise.
The (widget, user.data)
widget
GtkWidget
] the object which received the signal.user.data
The (widget, previous.screen, user.data)
widget
GtkWidget
] the object on which the signal is emittedprevious.screen
GdkScreen
] the previous screen, or NULL
if the
widget was not associated with a screen beforeuser.data
The (widget, event, user.data)
To receive this signal, the GdkWindow
associated to the widget needs
to enable the GDK_BUTTON_PRESS_MASK
mask.
This signal will be sent to the grab widget if there is one.
widget
GtkWidget
] the object which received the signal.event
GdkEventScroll
] the GdkEventScroll
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, event, user.data)
widget
's window has lost ownership of a selection.
widget
GtkWidget
] the object which received the signalevent
GdkEventSelection
] the GdkEventSelection
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, data, info, time, user.data)
widget
GtkWidget
] the object which received the signal.data
GtkSelectionData
] info
time
user.data
The (widget, event, user.data)
widget
GtkWidget
] the object which received the signal.event
GdkEventSelection
] user.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event. FALSE
to propagate the event further.
The (widget, data, time, user.data)
widget
GtkWidget
] the object which received the signal.data
GtkSelectionData
] time
user.data
The (widget, event, user.data)
widget
's window.
widget
GtkWidget
] the object which received the signalevent
GdkEventSelection
] the GdkEventSelection
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, user.data)
widget
GtkWidget
] the object which received the signal.user.data
The (widget, arg1, user.data)
widget
GtkWidget
] the object which received the signal.arg1
GtkWidgetHelpType
] user.data
The (widget, allocation, user.data)
widget
GtkWidget
] the object which received the signal.allocation
GtkAllocation
] user.data
The (widget, requisition, user.data)
widget
GtkWidget
] the object which received the signal.requisition
GtkRequisition
] user.data
The (widget, state, user.data)
widget
GtkWidget
] the object which received the signal.state
GtkStateType
] user.data
The (widget, previous.style, user.data)
gtkWidgetModifyBase
also cause this signal to be emitted.
widget
GtkWidget
] the object on which the signal is emittedprevious.style
GtkStyle
] the previous style, or NULL
if the widget
just got its initial style user.data
The (widget, user.data)
widget
GtkWidget
] the object which received the signal.user.data
The (widget, event, user.data)
widget
's window is
unmapped. A window is unmapped when it becomes invisible on the screen.
To receive this signal, the GdkWindow
associated to the widget needs
to enable the GDK_STRUCTURE_MASK
mask. GDK will enable this mask
automatically for all new windows.
widget
GtkWidget
] the object which received the signalevent
GdkEvent
] the GdkEventAny
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, user.data)
widget
GtkWidget
] the object which received the signal.user.data
The (widget, event, user.data)
widget
's window
is obscured or unobscured.
To receive this signal the GdkWindow
associated to the widget needs
to enable the GDK_VISIBILITY_NOTIFY_MASK
mask.
widget
GtkWidget
] the object which received the signalevent
GdkEventVisibility
] the GdkEventVisibility
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the event.
FALSE
to propagate the event further.
The (widget, event, user.data)
widget
changes.
To receive this signal the GdkWindow
associated to the widget
needs to enable the GDK_STRUCTURE_MASK
mask. GDK will enable
this mask automatically for all new windows.
widget
GtkWidget
] the object which received the signalevent
GdkEventWindowState
] the GdkEventWindowState
which triggered this signaluser.data
Returns: [logical] TRUE
to stop other handlers from being invoked for the
event. FALSE
to propagate the event further.
app-paintable
[logical : Read / Write]Whether the application will paint directly on the widget. Default value: FALSE
can-default
[logical : Read / Write]Whether the widget can be the default widget. Default value: FALSE
can-focus
[logical : Read / Write]Whether the widget can accept the input focus. Default value: FALSE
composite-child
[logical : Read]Whether the widget is part of a composite widget. Default value: FALSE
events
[GdkEventMask
: Read / Write]The event mask that decides what kind of GdkEvents this widget gets. Default value: GDK_STRUCTURE_MASK
extension-events
[GdkExtensionMode
: Read / Write]The mask that decides what kind of extension events this widget gets. Default value: GDK_EXTENSION_EVENTS_NONE
has-default
[logical : Read / Write]Whether the widget is the default widget. Default value: FALSE
has-focus
[logical : Read / Write]Whether the widget has the input focus. Default value: FALSE
has-tooltip
[logical : Read / Write]
Enables or disables the emission of ::query-tooltip
on widget
.
A value of TRUE
indicates that widget
can have a tooltip, in this case
the widget will be queried using ::query-tooltip
to determine
whether it will provide a tooltip or not.
Note that setting this property to TRUE
for the first time will change
the event masks of the GdkWindows of this widget to include leave-notify
and motion-notify events. This cannot and will not be undone when the
property is set to FALSE
again.
Default value: FALSE Since 2.12
height-request
[integer : Read / Write]Override for height request of the widget, or -1 if natural request should be used. Allowed values: >= -1 Default value: -1
is-focus
[logical : Read / Write]Whether the widget is the focus widget within the toplevel. Default value: FALSE
name
[character : Read / Write]The name of the widget. Default value: NULL
no-show-all
[logical : Read / Write]Whether gtk_widget_show_all() should not affect this widget. Default value: FALSE
parent
[GtkContainer
: Read / Write]The parent widget of this widget. Must be a Container widget.
receives-default
[logical : Read / Write]If TRUE, the widget will receive the default action when it is focused. Default value: FALSE
sensitive
[logical : Read / Write]Whether the widget responds to input. Default value: TRUE
style
[GtkStyle
: Read / Write]The style of the widget, which contains information about how it will look (colors etc).
tooltip-markup
[character : Read / Write]
Sets the text of tooltip to be the given string, which is marked up
with the Pango text markup language.
Also see gtkTooltipsetMarkup
.
This is a convenience property which will take care of getting the
tooltip shown if the given string is not NULL
: :has-tooltip
will automatically be set to TRUE
and there will be taken care of
::query-tooltip
in the default signal handler.
Default value: NULL Since 2.12
tooltip-text
[character : Read / Write]Sets the text of tooltip to be the given string.
Also see gtkTooltipsetText
.
This is a convenience property which will take care of getting the
tooltip shown if the given string is not NULL
: :has-tooltip
will automatically be set to TRUE
and there will be taken care of
::query-tooltip
in the default signal handler.
Default value: NULL Since 2.12
visible
[logical : Read / Write]Whether the widget is visible. Default value: FALSE
width-request
[integer : Read / Write]Override for width request of the widget, or -1 if natural request should be used. Allowed values: >= -1 Default value: -1
cursor-aspect-ratio
[numeric : Read]Aspect ratio with which to draw insertion cursor. Allowed values: [0,1] Default value: 0.04
cursor-color
[GdkColor
: Read]Color with which to draw insertion cursor.
draw-border
[GtkBorder
: Read]The "draw-border" style property defines the size of areas outside the widget's allocation to draw.
Since 2.8
focus-line-pattern
[character : Read]Dash pattern used to draw the focus indicator. Default value: "\001\001"
focus-line-width
[integer : Read]Width, in pixels, of the focus indicator line. Allowed values: >= 0 Default value: 1
focus-padding
[integer : Read]Width, in pixels, between focus indicator and the widget 'box'. Allowed values: >= 0 Default value: 1
interior-focus
[logical : Read]Whether to draw the focus indicator inside widgets. Default value: TRUE
link-color
[GdkColor
: Read]The "link-color" style property defines the color of unvisited links.
Since 2.10
scroll-arrow-hlength
[integer : Read]The "scroll-arrow-hlength" style property defines the length of horizontal scroll arrows.
Allowed values: >= 1 Default value: 16 Since 2.10
scroll-arrow-vlength
[integer : Read]The "scroll-arrow-vlength" style property defines the length of vertical scroll arrows.
Allowed values: >= 1 Default value: 16 Since 2.10
secondary-cursor-color
[GdkColor
: Read]Color with which to draw the secondary insertion cursor when editing mixed right-to-left and left-to-right text.
separator-height
[integer : Read]
The "separator-height" style property defines the height of separators.
This property only takes effect if :wide-separators
is TRUE
.
Allowed values: >= 0 Default value: 0 Since 2.10
separator-width
[integer : Read]
The "separator-width" style property defines the width of separators.
This property only takes effect if :wide-separators
is TRUE
.
Allowed values: >= 0 Default value: 0 Since 2.10
visited-link-color
[GdkColor
: Read]The "visited-link-color" style property defines the color of visited links.
Since 2.10
wide-separators
[logical : Read]The "wide-separators" style property defines whether separators have configurable width and should be drawn using a box instead of a line.
Default value: FALSE Since 2.10
Derived by RGtkGen from GTK+ documentation
http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html