Gtk::Widget Class Reference

Abstract Widget (Base class for all widgets). More...

Inherits Gtk::Object, and Atk::Implementor.

Inherited by Gtk::Calendar, Gtk::CellView, Gtk::Container, Gtk::DrawingArea, Gtk::Entry, Gtk::Invisible, Gtk::Misc, Gtk::ProgressBar, Gtk::Range, Gtk::Ruler, and Gtk::Separator.

Collaboration diagram for Gtk::Widget:

[legend]

List of all members.

Public Member Functions
virtual	~Widget ()
GtkWidget*	gobj ()
	Provides access to the underlying C GtkObject.
const GtkWidget*	gobj () const
	Provides access to the underlying C GtkObject.
bool	set_scroll_adjustments (Adjustment& hadjustment, Adjustment& vadjustment)
	For widgets that support scrolling, sets the scroll adjustments and returns `true`.
void	show ()
	Flags a widget to be displayed.
void	show_now ()
	Shows a widget.
void	hide ()
	Reverses the effects of show(), causing the widget to be hidden (invisible to the user).
void	show_all ()
	Recursively shows a widget, and any child widgets (if the widget is a container).
void	hide_all ()
	Recursively hides a widget and any child widgets.
void	queue_draw ()
	Equivalent to calling queue_draw_area() for the entire area of a widget.
void	queue_draw_area (int x, int y, int width, int height)
	Invalidates the rectangular area of widget defined by x, y, width and height by calling gdk_window_invalidate_rect() on the widget's window and all its child windows.
void	queue_resize ()
	This function is only for use in widget implementations.
Requisition	size_request () const
	This function is typically used when implementing a Gtk::Container subclass.
void	size_request (const Requisition& requisition)
	This function is typically used when implementing a Gtk::Container subclass.
void	size_allocate (const Allocation& allocation)
	This function is only used by Gtk::Container subclasses, to assign a size and position to their child widgets.
void	add_accelerator (const Glib::ustring& accel_signal, const Glib::RefPtr< AccelGroup >& accel_group, guint accel_key, Gdk::ModifierType accel_mods, AccelFlags accel_flags)
	Installs an accelerator for this widget in accel_group that causes accel_signal to be emitted if the accelerator is activated.
bool	remove_accelerator (const Glib::RefPtr< AccelGroup >& accel_group, guint accel_key, Gdk::ModifierType accel_mods)
	Removes an accelerator from widget, previously installed with add_accelerator().
void	set_accel_path (const Glib::ustring& accel_path, const Glib::RefPtr< AccelGroup >& accel_group)
	Given an accelerator group, accel_group, and an accelerator path, accel_path, sets up an accelerator in accel_group so whenever the key binding that is defined for accel_path is pressed, widget will be activated.
bool	mnemonic_activate (bool group_cycling)
	Emits the Gtk::Widget::mnemonic-activate signal.
bool	event (GdkEvent* event)
	Rarely-used function.
int	send_expose (GdkEvent* event)
	Very rarely-used function.
bool	activate ()
	For widgets that can be "activated" (buttons, menu items, etc.
void	reparent (Widget& new_parent)
	Moves a widget from one Gtk::Container to another, handling reference count issues to avoid destroying the widget.
bool	intersect (const Gdk::Rectangle& area) const
bool	intersect (const Gdk::Rectangle& area, Gdk::Rectangle& intersection) const
	Computes the intersection of a widget's area and area, storing the intersection in intersection, and returns `true` if there was an intersection.
Gdk::Region	region_intersect (const Gdk::Region& region) const
	Computes the intersection of a widget's area and region, returning the intersection.
void	freeze_child_notify ()
	Stops emission of Gtk::Widget::child-notify signals on widget.
void	child_notify (const Glib::ustring& child_property)
	Emits a Gtk::Widget::child-notify signal for the <link linkend="child-properties">child property</link> child_property on widget.
void	thaw_child_notify ()
	Reverts the effect of a previous call to freeze_child_notify().
void	set_can_focus (bool can_focus=true)
	Specifies whether widget can own the input focus.
bool	get_can_focus () const
	Determines whether widget can own the input focus.
bool	can_focus () const
	Determines whether widget can own the input focus.
bool	has_focus () const
	Determines if the widget has the global input focus.
bool	is_focus () const
	Determines if the widget is the focus widget within its toplevel.
void	grab_focus ()
	Causes widget to have the keyboard focus for the Gtk::Window it's inside.
void	set_can_default (bool can_default=true)
	Specifies whether widget can be a default widget.
bool	get_can_default () const
	Determines whether widget can be a default widget.
bool	can_default () const
	Determines whether widget can be a default widget.
bool	has_default () const
	Determines whether widget is the current default widget within its toplevel.
void	grab_default ()
	Causes widget to become the default widget.
void	set_receives_default (bool receives_default=true)
	Specifies whether widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
bool	get_receives_default () const
	Determines whether widget is alyways treated as default widget withing its toplevel when it has the focus, even if another widget is the default.
bool	has_grab () const
	Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse).
void	add_modal_grab ()
	Block events to everything else than this widget and its children.
void	remove_modal_grab ()
	Remove the modal grab of the widget in case it was previously grabbed.
void	set_name (const Glib::ustring& name)
	Widgets can be named, which allows you to refer to them from a gtkrc file.
void	unset_name ()
Glib::ustring	get_name () const
	Retrieves the name of a widget.
void	set_state (StateType state)
	This function is for use in widget implementations.
StateType	get_state () const
	Returns the widget's state.
void	set_sensitive (bool sensitive=true)
	Sets the sensitivity of a widget.
bool	get_sensitive () const
	Returns the widget's sensitivity (in the sense of returning the value that has been set using set_sensitive()).
bool	is_sensitive () const
	Returns the widget's effective sensitivity, which means it is sensitive itself and also its parent widget is sensntive.
void	set_visible (bool visible=true)
	Sets the visibility state of widget.
bool	get_visible () const
	Determines whether the widget is visible.
void	set_has_window (bool has_window=true)
	Specifies whether widget has a Gdk::Window of its own.
bool	get_has_window () const
	Determines whether widget has a Gdk::Window of its own.
bool	get_is_toplevel () const
	Determines whether widget is a toplevel widget.
bool	get_is_drawable () const
	Determines whether widget can be drawn to.
bool	get_realized () const
	Determines whether widget is realized.
bool	get_mapped () const
	Whether the widget is mapped.
void	set_app_paintable (bool app_paintable=true)
	Sets whether the application intends to draw on the widget in an Gtk::Widget::expose-event handler.
bool	get_app_paintable () const
	Determines whether the application intends to draw on the widget in an Gtk::Widget::expose-event handler.
void	set_double_buffered (bool double_buffered=true)
	Widgets are double buffered by default; you can use this function to turn off the buffering.
bool	get_double_buffered () const
	Determines whether the widget is double buffered.
void	set_redraw_on_allocate (bool redraw_on_allocate=true)
	Sets whether the entire widget is queued for drawing when its size allocation changes.
void	set_child_visible (bool is_visible=true)
	Sets whether widget should be mapped along with its when its parent is mapped and widget has been shown with show().
bool	get_child_visible () const
	Gets the value set with set_child_visible().
void	set_window (const Glib::RefPtr< Gdk::Window >& window)
	Sets a widget's window.
Glib::RefPtr< Gdk::Window >	get_window ()
	Returns the widget's window if it is realized, `0` otherwise.
Glib::RefPtr< const Gdk::Window >	get_window () const
	Returns the widget's window if it is realized, `0` otherwise.
Allocation	get_allocation () const
	Retrieves the widget's location.
void	set_allocation (const Allocation& allocation)
	Sets the widget's allocation.
Container*	get_parent ()
	Returns the parent container of widget.
const Container*	get_parent () const
	Returns the parent container of widget.
Glib::RefPtr< Gdk::Window >	get_parent_window ()
	Gets widget's parent window.
Glib::RefPtr< const Gdk::Window >	get_parent_window () const
	Gets widget's parent window.
void	set_parent_window (const Glib::RefPtr< const Gdk::Window >& parent_window)
	Sets a non default parent window for widget.
bool	child_focus (DirectionType direction)
	This function is used by custom widget implementations; if you're writing an app, you'd use grab_focus() to move the focus to a particular widget, and Gtk::Container::set_focus_chain() to change the focus tab order.
bool	keynav_failed (DirectionType direction)
	This function should be called whenever keyboard navigation within a single widget hits a boundary.
void	error_bell ()
	Notifies the user about an input-related error on this widget.
void	set_size_request (int width=-1, int height=-1)
	Sets the minimum size of a widget; that is, the widget's size request will be width by height.
void	get_size_request (int& width, int& height) const
	Gets the size request that was explicitly set for the widget using set_size_request().
void	set_events (Gdk::EventMask events)
	Sets the event mask (see Gdk::EventMask) for a widget.
void	add_events (Gdk::EventMask events)
	Adds the events in the bitfield events to the event mask for widget.
void	set_extension_events (Gdk::ExtensionMode mode)
	Sets the extension events mask to mode.
Gdk::ExtensionMode	get_extension_events () const
	Retrieves the extension events the widget will receive; see gdk_input_set_extension_events().
Container*	get_toplevel ()
	This function returns the topmost widget in the container hierarchy widget is a part of.
const Container*	get_toplevel () const
	This function returns the topmost widget in the container hierarchy widget is a part of.
Widget*	get_ancestor (GType widget_type)
	Gets the first ancestor of widget with type widget_type.
const Widget*	get_ancestor (GType widget_type) const
	Gets the first ancestor of widget with type widget_type.
Glib::RefPtr< Gdk::Colormap >	get_colormap ()
	Gets the colormap that will be used to render widget.
Glib::RefPtr< Gdk::Visual >	get_visual ()
	Gets the visual that will be used to render widget.
Glib::RefPtr< Gdk::Screen >	get_screen ()
	Get the Gdk::Screen from the toplevel window associated with this widget.
Glib::RefPtr< const Gdk::Screen >	get_screen () const
	Get the Gdk::Screen from the toplevel window associated with this widget.
bool	has_screen () const
	Checks whether there is a Gdk::Screen is associated with this widget.
Glib::RefPtr< Gdk::Display >	get_display ()
	Get the Gdk::Display for the toplevel window associated with this widget.
Glib::RefPtr< const Gdk::Display >	get_display () const
	Get the Gdk::Display for the toplevel window associated with this widget.
Glib::RefPtr< Gdk::Window >	get_root_window ()
	Get the root window where this widget is located.
Glib::RefPtr< const Gdk::Window >	get_root_window () const
	Get the root window where this widget is located.
Glib::RefPtr< Settings >	get_settings ()
	Gets the settings object holding the settings (global property settings, RC file information, etc) used for this widget.
Glib::RefPtr< Clipboard >	get_clipboard (const Glib::ustring& selection)
	Returns the clipboard object for the given selection to be used with widget.
Glib::RefPtr< const Clipboard >	get_clipboard (const Glib::ustring& selection) const
	Returns the clipboard object for the given selection to be used with widget.
Glib::RefPtr< Gdk::Pixmap >	get_snapshot (Gdk::Rectangle& clip_rect) const
	Create a Gdk::Pixmap of the contents of the widget and its children.
Glib::RefPtr< Gdk::Pixmap >	get_snapshot () const
	Create a Gdk::Pixmap of the contents of the widget and its children.
Glib::RefPtr< Atk::Object >	get_accessible ()
	Returns the accessible object that describes the widget to an assistive technology.
void	set_colormap (const Glib::RefPtr< const Gdk::Colormap >& colormap)
	Sets the colormap for the widget to the given value.
Gdk::EventMask	get_events () const
	Returns the event mask for the widget (a bitfield containing flags from the Gdk::EventMask enumeration).
void	get_pointer (int& x, int& y) const
	Obtains the location of the mouse pointer in widget coordinates.
bool	is_ancestor (Widget& ancestor) const
	Determines whether widget is somewhere inside ancestor, possibly with intermediate containers.
bool	translate_coordinates (Widget& dest_widget, int src_x, int src_y, int& dest_x, int& dest_y)
	Translate coordinates relative to src_widget's allocation to coordinates relative to dest_widget's allocations.
bool	has_rc_style () const
	Determines if the widget style has been looked up through the rc mechanism.
void	set_style (const Glib::RefPtr< Style >& style)
	Sets the Gtk::Style for a widget ( widget->style).
void	unset_style ()
void	ensure_style ()
	Ensures that widget has a style ( widget->style).
Glib::RefPtr< Style >	get_style ()
	Simply an accessor function that returns widget->style.
Glib::RefPtr< const Style >	get_style () const
	Simply an accessor function that returns widget->style.
void	modify_style (const Glib::RefPtr< RcStyle >& style)
	Modifies style values on the widget.
Glib::RefPtr< RcStyle >	get_modifier_style ()
	Returns the current modifier style for the widget.
Glib::RefPtr< const RcStyle >	get_modifier_style () const
	Returns the current modifier style for the widget.
void	modify_fg (StateType state, const Gdk::Color& color)
	Sets the foreground color for a widget in a particular state.
void	modify_bg (StateType state, const Gdk::Color& color)
	Sets the background color for a widget in a particular state.
void	modify_bg_pixmap (StateType state, const Glib::ustring& pixmap_name)
void	modify_text (StateType state, const Gdk::Color& color)
	Sets the text color for a widget in a particular state.
void	modify_base (StateType state, const Gdk::Color& color)
	Sets the base color for a widget in a particular state.
void	modify_cursor (const Gdk::Color& primary, const Gdk::Color& secondary)
	Sets the cursor color to use in a widget, overriding the cursor_color and secondary_cursor_color style properties.
void	unset_cursor ()
	See modify_cursor().
void	modify_font (const Pango::FontDescription& font_desc)
	Sets the font to use for a widget.
void	unset_fg (StateType state)
	Undo the effect of previous calls to modify_fg() for a particular state.
void	unset_bg (StateType state)
	Undo the effect of previous calls to modify_bg() for a particular state.
void	unset_text (StateType state)
	Undo the effect of previous calls to modify_text() for a particular state.
void	unset_base (StateType state)
	Undo the effect of previous calls to modify_base() for a particular state.
void	unset_font ()
	Undo the effect of previous calls to modify_font() for a particular state.
template<class PropertyType >
void	get_style_property (const Glib::ustring& the_property_name, PropertyType&value) const
Glib::RefPtr< Pango::Context >	create_pango_context ()
	Creates a new Pango::Context with the appropriate font map, font description, and base direction for drawing text for this widget.
Glib::RefPtr< Pango::Context >	get_pango_context ()
	Gets a Pango::Context with the appropriate font map, font description, and base direction for this widget.
Glib::RefPtr< Pango::Layout >	create_pango_layout (const Glib::ustring& text)
	Creates a new Pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget.
Glib::RefPtr< Gdk::Pixbuf >	render_icon (const StockID& stock_id, IconSize size, const Glib::ustring& detail=Glib::ustring())
	A convenience function that uses the theme engine and RC file settings for the widget to look up stock_id and render it to a pixbuf.
void	set_composite_name (const Glib::ustring& name)
	Sets a widgets composite name.
void	unset_composite_name ()
Glib::ustring	get_composite_name () const
	Obtains the composite name of a widget.
void	reset_rc_styles ()
	Reset the styles of widget and all descendents, so when they are looked up again, they get the correct values for the currently loaded RC file settings.
void	set_direction (TextDirection dir)
	Sets the reading direction on a particular widget.
TextDirection	get_direction ()
	Gets the reading direction for a particular widget.
TextDirection	get_direction () const
	Gets the reading direction for a particular widget.
void	shape_combine_mask (const Glib::RefPtr< const Gdk::Bitmap >& shape_mask, int offset_x, int offset_y)
	Sets a shape for this widget's GDK window.
void	unset_shape_combine_mask ()
void	input_shape_combine_mask (const Glib::RefPtr< const Gdk::Bitmap >& shape_mask, int offset_x, int offset_y)
	Sets an input shape for this widget's GDK window.
void	unset_input_shape_combine_mask ()
void	reset_shapes ()
	Recursively resets the shape on this widget and its descendants.
void	path (Glib::ustring& path, Glib::ustring& path_reversed)
	Compute a widget's path of the form "GtkWindow.MyLabel".
void	class_path (Glib::ustring& path, Glib::ustring& path_reversed)
Glib::ListHandle< Widget* >	list_mnemonic_labels ()
	Returns a newly allocated list of the widgets, normally labels, for which this widget is a the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()).
Glib::ListHandle< const Widget* >	list_mnemonic_labels () const
	Returns a newly allocated list of the widgets, normally labels, for which this widget is a the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()).
void	add_mnemonic_label (Widget& label)
	Adds a widget to the list of mnemonic labels for this widget.
void	remove_mnemonic_label (Widget& label)
	Removes a widget from the list of mnemonic labels for this widget.
void	drag_get_data (const Glib::RefPtr< Gdk::DragContext >& context, Glib::ustring& target, guint32 time)
void	drag_get_data (const Glib::RefPtr< Gdk::DragContext >& context, const Glib::ustring& target, guint32 time)
void	drag_highlight ()
void	drag_unhighlight ()
void	drag_dest_set (DestDefaults flags=DestDefaults(0), Gdk::DragAction actions=Gdk::DragAction(0))
void	drag_dest_set (const ArrayHandle_TargetEntry& targets, DestDefaults flags=DEST_DEFAULT_ALL, Gdk::DragAction actions=Gdk::ACTION_COPY)
void	drag_dest_set_proxy (const Glib::RefPtr< Gdk::Window >& proxy_window, Gdk::DragProtocol protocol, bool use_coordinates)
void	drag_dest_unset ()
Glib::ustring	drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext >& context, const Glib::RefPtr< TargetList >& target_list) const
	Looks for a match between context->targets and the dest_target_list, returning the first matching target, otherwise returning Gdk::NONE.
Glib::ustring	drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext >& context) const
Glib::RefPtr< TargetList >	drag_dest_get_target_list ()
	Returns the list of targets this widget can accept from drag-and-drop.
Glib::RefPtr< const TargetList >	drag_dest_get_target_list () const
	Returns the list of targets this widget can accept from drag-and-drop.
void	drag_dest_set_target_list (const Glib::RefPtr< TargetList >& target_list)
	Sets the target types that this widget can accept from drag-and-drop.
void	drag_dest_add_text_targets ()
	Add the text targets supported by Gtk::Selection to the target list of the drag destination.
void	drag_dest_add_image_targets ()
	Add the image targets supported by Gtk::Selection to the target list of the drag destination.
void	drag_dest_add_uri_targets ()
	Add the URI targets supported by Gtk::Selection to the target list of the drag destination.
void	drag_source_set (const ArrayHandle_TargetEntry& targets, Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY)
void	drag_source_unset ()
void	drag_source_set_icon (const Glib::RefPtr< Gdk::Colormap >& colormap, const Glib::RefPtr< Gdk::Pixmap >& pixmap, const Glib::RefPtr< Gdk::Bitmap >& mask)
	Sets the icon that will be used for drags from a particular widget from a pixmap/mask.
void	drag_source_set_icon (const Glib::RefPtr< Gdk::Pixbuf >& pixbuf)
	Sets the icon that will be used for drags from a particular widget from a Gdk::Pixbuf.
void	drag_source_set_icon (const StockID& stock_id)
	Sets the icon that will be used for drags from a particular source to a stock icon.
void	drag_source_set_icon (const Glib::ustring& icon_name)
	Sets the icon that will be used for drags from a particular source to a themed icon.
void	drag_source_add_text_targets ()
	Add the text targets supported by Gtk::Selection to the target list of the drag source.
void	drag_source_add_uri_targets ()
	Add the URI targets supported by Gtk::Selection to the target list of the drag source.
void	drag_source_add_image_targets ()
	Add the writable image targets supported by Gtk::Selection to the target list of the drag source.
Glib::RefPtr< Gdk::DragContext >	drag_begin (const Glib::RefPtr< TargetList >& targets, Gdk::DragAction actions, int button, GdkEvent* event)
	Initiates a drag on the source side.
bool	drag_check_threshold (int start_x, int start_y, int current_x, int current_y)
	Checks to see if a mouse drag starting at ( start_x, start_y) and ending at ( current_x, current_y) has passed the GTK+ drag threshold, and thus should trigger the beginning of a drag-and-drop operation.
void	drag_set_as_icon (const Glib::RefPtr< Gdk::DragContext >& context, int hot_x, int hot_y)
void	queue_resize_no_redraw ()
	This function works like queue_resize(), except that the widget is not invalidated.
bool	get_no_show_all () const
	Returns the current value of the GtkWidget:no-show-all property, which determines whether calls to show_all() and hide_all() will affect this widget.
void	set_no_show_all (bool no_show_all=true)
	Sets the Gtk::Widget:no-show-all property, which determines whether calls to show_all() and hide_all() will affect this widget.
void	set_parent (Widget& parent)
	This function is useful only when implementing subclasses of Gtk::Container.
void	unparent ()
	This function is only for use in widget implementations.
void	map ()
	This function is only for use in widget implementations.
void	unmap ()
	This function is only for use in widget implementations.
void	draw_insertion_cursor (Glib::RefPtr< Gdk::Drawable > drawable, const Gdk::Rectangle& area, const Gdk::Rectangle& location, bool is_primary, TextDirection direction, bool draw_arrow=true)
void	set_tooltip_window (Window& widget)
	Replaces the default, usually yellow, window used for displaying tooltips with custom_window.
Window*	get_tooltip_window ()
	Returns the Gtk::Window of the current tooltip.
void	trigger_tooltip_query ()
	Triggers a tooltip query on the display where the toplevel of widget is located.
void	set_tooltip_text (const Glib::ustring& text)
	Sets text as the contents of the tooltip.
Glib::ustring	get_tooltip_text () const
	Gets the contents of the tooltip for widget.
void	set_tooltip_markup (const Glib::ustring& markup)
	Sets markup as the contents of the tooltip, which is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
Glib::ustring	get_tooltip_markup () const
	Gets the contents of the tooltip for widget.
void	set_has_tooltip (bool has_tooltip=TRUE)
	Sets the has-tooltip property on widget to has_tooltip.
bool	get_has_tooltip () const
	Returns the current value of the has-tooltip property.
bool	has_no_window () const
bool	is_realized () const
bool	is_mapped () const
bool	is_toplevel () const
bool	is_drawable () const
bool	is_visible () const
bool	sensitive () const
bool	app_paintable () const
bool	receives_default () const
bool	double_buffered () const
bool	parent_sensitive () const
bool	rc_style () const
bool	is_composite_child () const
	Returns trye if the widget is a composite child of its parent.
WidgetFlags	get_flags () const
void	set_flags (WidgetFlags flags)
void	unset_flags (WidgetFlags flags)
Gtk::StateType	get_saved_state () const
int	get_width () const
int	get_height () const
bool	is_composited () const
	Whether widget can rely on having its alpha channel drawn correctly.
Glib::RefPtr< Action >	get_action ()
	Returns the Gtk::Action that widget is a proxy for.
Glib::RefPtr< const Action >	get_action () const
	Returns the Gtk::Action that widget is a proxy for.
Requisition	get_requisition () const
	Retrieves the widget's requisition.
Glib::SignalProxy0< void >	signal_show ()
Glib::SignalProxy0< void >	signal_hide ()
Glib::SignalProxy0< void >	signal_map ()
	Emitted on mapping of a widget to the screen.
Glib::SignalProxy0< void >	signal_unmap ()
Glib::SignalProxy0< void >	signal_realize ()
	Emitted on realization of a widget.
Glib::SignalProxy0< void >	signal_unrealize ()
Glib::SignalProxy1< void, Requisition* >	signal_size_request ()
Glib::SignalProxy1< void, Allocation& >	signal_size_allocate ()
Glib::SignalProxy1< void, Gtk::StateType >	signal_state_changed ()
Glib::SignalProxy1< void, Widget* >	signal_parent_changed ()
	Informs objects that their parent changed.
Glib::SignalProxy1< void, Widget* >	signal_hierarchy_changed ()
Glib::SignalProxy1< void, const Glib::RefPtr< Gtk::Style >& >	signal_style_changed ()
	The style-set signal is emitted when a new style has been set on a widget.
Glib::SignalProxy1< void, TextDirection >	signal_direction_changed ()
Glib::SignalProxy1< void, bool >	signal_grab_notify ()
Glib::SignalProxy1< void, GParamSpec* >	signal_child_notify ()
	The child-notify signal is emitted for each child property that has changed on an object.
Glib::SignalProxy1< bool, bool >	signal_mnemonic_activate ()
Glib::SignalProxy0< void >	signal_grab_focus ()
Glib::SignalProxy1< bool, DirectionType >	signal_focus ()
Glib::SignalProxy1< bool, GdkEvent* >	signal_event ()
Glib::SignalProxy1< void, GdkEvent* >	signal_event_after ()
Glib::SignalProxy1< bool, GdkEventButton* >	signal_button_press_event ()
	Event triggered by user pressing button.
Glib::SignalProxy1< bool, GdkEventButton* >	signal_button_release_event ()
	Event triggered by user releasing button.
Glib::SignalProxy1< bool, GdkEventScroll* >	signal_scroll_event ()
Glib::SignalProxy1< bool, GdkEventMotion* >	signal_motion_notify_event ()
	Event triggered by user moving pointer.
Glib::SignalProxy1< bool, GdkEventAny* >	signal_delete_event ()
	The delete_event signal is emitted if a user requests that a toplevel window is closed.
Glib::SignalProxy1< bool, GdkEventExpose* >	signal_expose_event ()
	Event triggered by window requiring a refresh.
Glib::SignalProxy1< bool, GdkEventKey* >	signal_key_press_event ()
	Event triggered by a key press will widget has focus.
Glib::SignalProxy1< bool, GdkEventKey* >	signal_key_release_event ()
	Event triggered by a key release will widget has focus.
Glib::SignalProxy1< bool, GdkEventCrossing* >	signal_enter_notify_event ()
	Event triggered by pointer entering widget area.
Glib::SignalProxy1< bool, GdkEventCrossing* >	signal_leave_notify_event ()
	Event triggered by pointer leaving widget area.
Glib::SignalProxy1< bool, GdkEventConfigure* >	signal_configure_event ()
	Event triggered by a window resizing.
Glib::SignalProxy1< bool, GdkEventFocus* >	signal_focus_in_event ()
Glib::SignalProxy1< bool, GdkEventFocus* >	signal_focus_out_event ()
Glib::SignalProxy1< bool, GdkEventAny* >	signal_map_event ()
Glib::SignalProxy1< bool, GdkEventAny* >	signal_unmap_event ()
Glib::SignalProxy1< bool, GdkEventProperty* >	signal_property_notify_event ()
Glib::SignalProxy1< bool, GdkEventSelection* >	signal_selection_clear_event ()
Glib::SignalProxy1< bool, GdkEventSelection* >	signal_selection_request_event ()
Glib::SignalProxy1< bool, GdkEventSelection* >	signal_selection_notify_event ()
Glib::SignalProxy1< bool, GdkEventProximity* >	signal_proximity_in_event ()
Glib::SignalProxy1< bool, GdkEventProximity* >	signal_proximity_out_event ()
Glib::SignalProxy1< bool, GdkEventVisibility* >	signal_visibility_notify_event ()
Glib::SignalProxy1< bool, GdkEventClient* >	signal_client_event ()
Glib::SignalProxy1< bool, GdkEventAny* >	signal_no_expose_event ()
Glib::SignalProxy1< bool, GdkEventWindowState* >	signal_window_state_event ()
Glib::SignalProxy3< void, SelectionData&, guint, guint >	signal_selection_get ()
Glib::SignalProxy2< void, const SelectionData&, guint >	signal_selection_received ()
Glib::SignalProxy1< void, const Glib::RefPtr < Gdk::DragContext >& >	signal_drag_begin ()
	The drag_begin signal is emitted on the drag source when a drag is started.
Glib::SignalProxy1< void, const Glib::RefPtr < Gdk::DragContext >& >	signal_drag_end ()
	The drag_end signal is emitted on the drag source when a drag is finished.
Glib::SignalProxy4< void, const Glib::RefPtr < Gdk::DragContext > &, SelectionData&, guint, guint >	signal_drag_data_get ()
	The drag_data_get signal is emitted on the drag source when the drop site requests the data which is dragged.
Glib::SignalProxy1< void, const Glib::RefPtr < Gdk::DragContext >& >	signal_drag_data_delete ()
	The drag_data_delete signal is emitted on the drag source when a drag with the action Gdk::ACTION_MOVE is successfully completed.
Glib::SignalProxy2< bool, const Glib::RefPtr < Gdk::DragContext > &, DragResult >	signal_drag_failed ()
Glib::SignalProxy2< void, const Glib::RefPtr < Gdk::DragContext >&, guint >	signal_drag_leave ()
	The drag_leave signal is emitted on the drop site when the cursor leaves the widget.
Glib::SignalProxy4< bool, const Glib::RefPtr < Gdk::DragContext >&, int, int, guint >	signal_drag_motion ()
	The drag_motion signal is emitted on the drop site when the user moves the cursor over the widget during a drag.
Glib::SignalProxy4< bool, const Glib::RefPtr < Gdk::DragContext >&, int, int, guint >	signal_drag_drop ()
	The drag_drop signal is emitted on the drop site when the user drops the data onto the widget.
Glib::SignalProxy6< void, const Glib::RefPtr < Gdk::DragContext >&, int, int, const SelectionData &, guint, guint >	signal_drag_data_received ()
	The drag_data_received signal is emitted on the drop site when the dragged data has been received.
Glib::SignalProxy0 < Glib::RefPtr< Atk::Object > >	signal_get_accessible ()
Glib::SignalProxy1< void, const Glib::RefPtr < Gdk::Screen >& >	signal_screen_changed ()
Glib::SignalProxy0< void >	signal_composited_changed ()
Glib::SignalProxy0< bool >	signal_popup_menu ()
Glib::SignalProxy4< bool, int, int, bool, const Glib::RefPtr < Tooltip >& >	signal_query_tooltip ()
Glib::SignalProxy1< bool, GdkEventGrabBroken* >	signal_grab_broken_event ()
Glib::SignalProxy1< bool, GdkEventExpose* >	signal_damage_event ()
Glib::PropertyProxy < Glib::ustring >	property_name ()
	The name of the widget.
Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_name () const
	The name of the widget.
Glib::PropertyProxy< Container* >	property_parent ()
	The parent widget of this widget.
Glib::PropertyProxy_ReadOnly < Container* >	property_parent () const
	The parent widget of this widget.
Glib::PropertyProxy< int >	property_width_request ()
	Override for width request of the widget.
Glib::PropertyProxy_ReadOnly< int >	property_width_request () const
	Override for width request of the widget.
Glib::PropertyProxy< int >	property_height_request ()
	Override for height request of the widget.
Glib::PropertyProxy_ReadOnly< int >	property_height_request () const
	Override for height request of the widget.
Glib::PropertyProxy< bool >	property_visible ()
	Whether the widget is visible.
Glib::PropertyProxy_ReadOnly < bool >	property_visible () const
	Whether the widget is visible.
Glib::PropertyProxy< bool >	property_sensitive ()
	Whether the widget responds to input.
Glib::PropertyProxy_ReadOnly < bool >	property_sensitive () const
	Whether the widget responds to input.
Glib::PropertyProxy< bool >	property_app_paintable ()
	Whether the application will paint directly on the widget.
Glib::PropertyProxy_ReadOnly < bool >	property_app_paintable () const
	Whether the application will paint directly on the widget.
Glib::PropertyProxy< bool >	property_can_focus ()
	Whether the widget can accept the input focus.
Glib::PropertyProxy_ReadOnly < bool >	property_can_focus () const
	Whether the widget can accept the input focus.
Glib::PropertyProxy< bool >	property_has_focus ()
	Whether the widget has the input focus.
Glib::PropertyProxy_ReadOnly < bool >	property_has_focus () const
	Whether the widget has the input focus.
Glib::PropertyProxy< bool >	property_can_default ()
	Whether the widget can be the default widget.
Glib::PropertyProxy_ReadOnly < bool >	property_can_default () const
	Whether the widget can be the default widget.
Glib::PropertyProxy< bool >	property_has_default ()
	Whether the widget is the default widget.
Glib::PropertyProxy_ReadOnly < bool >	property_has_default () const
	Whether the widget is the default widget.
Glib::PropertyProxy< bool >	property_receives_default ()
	If TRUE.
Glib::PropertyProxy_ReadOnly < bool >	property_receives_default () const
	If TRUE.
Glib::PropertyProxy_ReadOnly < bool >	property_composite_child () const
	Whether the widget is part of a composite widget.
Glib::PropertyProxy < Glib::RefPtr< Style > >	property_style ()
	The style of the widget.
Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Style > >	property_style () const
	The style of the widget.
Glib::PropertyProxy < Gdk::EventMask >	property_events ()
	The event mask that decides what kind of GdkEvents this widget gets.
Glib::PropertyProxy_ReadOnly < Gdk::EventMask >	property_events () const
	The event mask that decides what kind of GdkEvents this widget gets.
Glib::PropertyProxy < Gdk::ExtensionMode >	property_extension_events ()
	The mask that decides what kind of extension events this widget gets.
Glib::PropertyProxy_ReadOnly < Gdk::ExtensionMode >	property_extension_events () const
	The mask that decides what kind of extension events this widget gets.
Glib::PropertyProxy< bool >	property_has_tooltip ()
	Whether this widget has a tooltip.
Glib::PropertyProxy_ReadOnly < bool >	property_has_tooltip () const
	Whether this widget has a tooltip.
Glib::PropertyProxy < Glib::ustring >	property_tooltip_markup ()
	The contents of the tooltip for this widget.
Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_tooltip_markup () const
	The contents of the tooltip for this widget.
Glib::PropertyProxy < Glib::ustring >	property_tooltip_text ()
	The contents of the tooltip for this widget.
Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_tooltip_text () const
	The contents of the tooltip for this widget.
Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Gdk::Window > >	property_window () const
	The widget's window if it is realized.
Glib::PropertyProxy< bool >	property_no_show_all ()
	Whether gtk_widget_show_all() should not affect this widget.
Glib::PropertyProxy_ReadOnly < bool >	property_no_show_all () const
	Whether gtk_widget_show_all() should not affect this widget.
Static Public Member Functions
static Widget*	get_current_modal_grab ()
	Retrieve the widget which is currently grabbing all events.
static void	push_colormap (const Glib::RefPtr< const Gdk::Colormap >& cmap)
	Pushes cmap onto a global stack of colormaps; the topmost colormap on the stack will be used to create all widgets.
static void	pop_colormap ()
	Removes a colormap pushed with push_colormap().
static void	push_composite_child ()
	Makes all newly-created widgets as composite children until the corresponding pop_composite_child() call.
static void	pop_composite_child ()
	Cancels the effect of a previous call to push_composite_child().
static void	set_default_colormap (const Glib::RefPtr< const Gdk::Colormap >& colormap)
	Sets the default colormap to use when creating widgets.
static Glib::RefPtr< Style >	get_default_style ()
	Returns the default style used by all widgets initially.
static Glib::RefPtr < Gdk::Colormap >	get_default_colormap ()
	Obtains the default colormap used to create widgets.
static Glib::RefPtr< Gdk::Visual >	get_default_visual ()
	Obtains the visual of the default colormap.
static void	set_default_direction (TextDirection dir)
	Sets the default reading direction for widgets where the direction has not been explicitly set by set_direction().
static TextDirection	get_default_direction ()
	Obtains the current default reading direction.
static Widget*	drag_get_source_widget (const Glib::RefPtr< Gdk::DragContext >& context)
Protected Member Functions
virtual void	on_show ()
virtual void	on_hide ()
virtual void	on_map ()
virtual void	on_unmap ()
virtual void	on_realize ()
virtual void	on_unrealize ()
virtual void	on_size_request (Requisition* requisition)
virtual void	on_size_allocate (Allocation& allocation)
virtual void	on_state_changed (Gtk::StateType previous_state)
virtual void	on_parent_changed (Widget* previous_parent)
virtual void	on_hierarchy_changed (Widget* previous_toplevel)
virtual void	on_style_changed (const Glib::RefPtr< Gtk::Style >& previous_style)
virtual void	on_direction_changed (TextDirection direction)
virtual void	on_grab_notify (bool was_grabbed)
virtual void	on_child_notify (GParamSpec* pspec)
virtual bool	on_mnemonic_activate (bool group_cycling)
virtual void	on_grab_focus ()
virtual bool	on_focus (DirectionType direction)
virtual bool	on_event (GdkEvent* event)
virtual bool	on_button_press_event (GdkEventButton* event)
virtual bool	on_button_release_event (GdkEventButton* event)
virtual bool	on_scroll_event (GdkEventScroll* event)
virtual bool	on_motion_notify_event (GdkEventMotion* event)
virtual bool	on_delete_event (GdkEventAny* event)
virtual bool	on_expose_event (GdkEventExpose* event)
virtual bool	on_key_press_event (GdkEventKey* event)
virtual bool	on_key_release_event (GdkEventKey* event)
virtual bool	on_enter_notify_event (GdkEventCrossing* event)
virtual bool	on_leave_notify_event (GdkEventCrossing* event)
virtual bool	on_configure_event (GdkEventConfigure* event)
virtual bool	on_focus_in_event (GdkEventFocus* event)
virtual bool	on_focus_out_event (GdkEventFocus* event)
virtual bool	on_map_event (GdkEventAny* event)
virtual bool	on_unmap_event (GdkEventAny* event)
virtual bool	on_property_notify_event (GdkEventProperty* event)
virtual bool	on_selection_clear_event (GdkEventSelection* event)
virtual bool	on_selection_request_event (GdkEventSelection* event)
virtual bool	on_selection_notify_event (GdkEventSelection* event)
virtual bool	on_proximity_in_event (GdkEventProximity* event)
virtual bool	on_proximity_out_event (GdkEventProximity* event)
virtual bool	on_visibility_notify_event (GdkEventVisibility* event)
virtual bool	on_client_event (GdkEventClient* event)
virtual bool	on_no_expose_event (GdkEventAny* event)
virtual bool	on_window_state_event (GdkEventWindowState* event)
virtual void	on_selection_get (SelectionData& selection_data, guint info, guint time)
virtual void	on_selection_received (const SelectionData& selection_data, guint time)
virtual void	on_drag_begin (const Glib::RefPtr< Gdk::DragContext >& context)
virtual void	on_drag_end (const Glib::RefPtr< Gdk::DragContext >& context)
virtual void	on_drag_data_get (const Glib::RefPtr< Gdk::DragContext >& context, SelectionData& selection_data, guint info, guint time)
virtual void	on_drag_data_delete (const Glib::RefPtr< Gdk::DragContext >& context)
virtual void	on_drag_leave (const Glib::RefPtr< Gdk::DragContext >& context, guint time)
virtual bool	on_drag_motion (const Glib::RefPtr< Gdk::DragContext >& context, int x, int y, guint time)
virtual bool	on_drag_drop (const Glib::RefPtr< Gdk::DragContext >& context, int x, int y, guint time)
virtual void	on_drag_data_received (const Glib::RefPtr< Gdk::DragContext >& context, int x, int y, const SelectionData& selection_data, guint info, guint time)
virtual Glib::RefPtr< Atk::Object >	on_get_accessible ()
virtual void	on_screen_changed (const Glib::RefPtr< Gdk::Screen >& previous_screen)
virtual void	dispatch_child_properties_changed_vfunc (guint p1, GParamSpec** p2)
virtual void	show_all_vfunc ()
virtual void	hide_all_vfunc ()
virtual Glib::RefPtr< Atk::Object >	get_accessible_vfunc ()
	Widget ()
void	realize ()
	Creates the GDK (windowing system) resources associated with a widget.
void	unrealize ()
	This function is only useful in widget implementations.
void	set_mapped (bool mapped=true)
	Marks the widget as being realized.
void	set_realized (bool realized=true)
	Marks the widget as being realized.
void	style_attach ()
	This function attaches the widget's Gtk::Style to the widget's Gdk::Window.
void	get_child_requisition (Requisition& requisition) const
	This function is only for use in widget implementations.
void	get_style_property_value (const Glib::ustring& the_property_name, Glib::ValueBase&value) const
	Gets the value of a style property of widget.
void	realize_if_needed ()
Related Functions
(Note that these are not member functions.)
Gtk::Widget*	wrap (GtkWidget* object, bool take_copy=false)
	A Glib::wrap() method for this object.

Detailed Description

Abstract Widget (Base class for all widgets).

As the base class of all widgets this contains all of the properties and methods common to all widgets. It is an abstract class that can not be instantiated.

Important part of widgets are the *_event signals and virtual methods that every widget have. Those are events coming directly from gdk and thus also from XLib. By overriding those virtual methods you can trap everything a widget can ever do. In order to capture events from a widget, the event mask must first be set with ().

Only widgets with a Gdk::Window on the server side are allowed to capture events. Widgets in the Gtk::Misc group for example lack a Gdk::Window.

Constructor & Destructor Documentation

virtual Gtk::Widget::~Widget ( ) [virtual]

Gtk::Widget::Widget ( ) [protected]

Member Function Documentation

bool Gtk::Widget::activate ( )

For widgets that can be "activated" (buttons, menu items, etc.

) this function activates them. Activation is what happens when you press Enter on a widget during key navigation. If widget isn't activatable, the function returns false.

Returns:: true if the widget was activatable.

Reimplemented in Gtk::MenuItem.

void Gtk::Widget::add_accelerator	(	const Glib::ustring &	accel_signal,
		const Glib::RefPtr< AccelGroup >&	accel_group,
		guint	accel_key,
		Gdk::ModifierType	accel_mods,
		AccelFlags	accel_flags
	)

Installs an accelerator for this widget in accel_group that causes accel_signal to be emitted if the accelerator is activated.

The accel_group needs to be added to the widget's toplevel via Gtk::Window::add_accel_group(), and the signal must be of type RUN_ACTION. Accelerators added through this function are not user changeable during runtime. If you want to support accelerators that can be changed by the user, use Gtk::AccelMap::add_entry() and set_accel_path() or Gtk::MenuItem::set_accel_path() instead.

Parameters:

	accel_signal	Widget signal to emit on accelerator activation.
	accel_group	Accel group for this widget, added to its toplevel.
	accel_key	GDK keyval of the accelerator.
	accel_mods	Modifier key combination of the accelerator.
	accel_flags	Flag accelerators, e.g. Gtk::ACCEL_VISIBLE.

void Gtk::Widget::add_events ( Gdk::EventMask events )

Adds the events in the bitfield events to the event mask for widget.

See set_events() for details.

Parameters:

events

An event mask, see Gdk::EventMask.

void Gtk::Widget::add_mnemonic_label ( Widget& label )

Adds a widget to the list of mnemonic labels for this widget.

(See list_mnemonic_labels()). Note the list of mnemonic labels for the widget is cleared when the widget is destroyed, so the caller must make sure to update its internal state at this point as well.

Since gtkmm 2.4:

Parameters:

label

A Gtk::Widget that acts as a mnemonic label for widget.

void Gtk::Widget::add_modal_grab ( )

Block events to everything else than this widget and its children.

This way you can get modal behaviour (usually not recommended). One practical example could be when implementing a key-binding widget that needs exclusive access to the key combination that the user presses next.

Calls to add_modal_grab should be paired with calls to remove_modal_grab.

bool Gtk::Widget::app_paintable ( ) const

Deprecated:: : Use get_app_paintable() instead.

bool Gtk::Widget::can_default ( ) const

Determines whether widget can be a default widget.

See set_can_default().

Since gtkmm 2.18:

Deprecated:: Replaced by get_can_default().

Returns:: true if widget can be a default widget, false otherwise.

bool Gtk::Widget::can_focus ( ) const

Determines whether widget can own the input focus.

See set_can_focus().

Since gtkmm 2.18:

Deprecated:: Replaced by get_can_focus().

Returns:: true if widget can own the input focus, false otherwise.

bool Gtk::Widget::child_focus ( DirectionType direction )

This function is used by custom widget implementations; if you're writing an app, you'd use grab_focus() to move the focus to a particular widget, and Gtk::Container::set_focus_chain() to change the focus tab order.

So you may want to investigate those functions instead.

child_focus() is called by containers as the user moves around the window using keyboard shortcuts. direction indicates what kind of motion is taking place (up, down, left, right, tab forward, tab backward). child_focus() emits the Gtk::Widget::focus signal; widgets override the default handler for this signal in order to implement appropriate focus behavior.

The default focus handler for a widget should return true if moving in direction left the focus on a focusable location inside that widget, and false if moving in direction moved the focus outside the widget. If returning true, widgets normally call grab_focus() to place the focus accordingly; if returning false, they don't modify the current focus location.

This function replaces gtk_container_focus() from GTK+ 1.2. It was necessary to check that the child was visible, sensitive, and focusable before calling gtk_container_focus(). child_focus() returns false if the widget is not currently in a focusable state, so there's no need for those checks.

Parameters:

direction

Direction of focus movement.

Returns:: true if focus ended up inside widget.

void Gtk::Widget::child_notify ( const Glib::ustring & child_property )

Emits a Gtk::Widget::child-notify signal for the <link linkend="child-properties">child property</link> child_property on widget.

This is the analogue of Glib::object_notify() for child properties.

Parameters:

child_property

The name of a child property installed on the class of widget's parent.

void Gtk::Widget::class_path	(	Glib::ustring &	path,
		Glib::ustring &	path_reversed
	)

Glib::RefPtr<Pango::Context> Gtk::Widget::create_pango_context ( )

Creates a new Pango::Context with the appropriate font map, font description, and base direction for drawing text for this widget.

See also gtk_grab_add().

Since gtkmm 2.18:

Returns:: true if the widget is in the grab_widgets stack.

bool Gtk::Widget::has_no_window ( ) const

Deprecated:: Use !get_has_window() instead.

bool Gtk::Widget::has_rc_style ( ) const

Determines if the widget style has been looked up through the rc mechanism.

Since gtkmm 2.20:

Returns:: true if the widget has been looked up through the rc mechanism, false otherwise.

bool Gtk::Widget::has_screen ( ) const

Checks whether there is a Gdk::Screen is associated with this widget.

All toplevel widgets have an associated screen, and all widgets added into a hierarchy with a toplevel window at the top.

Since gtkmm 2.2:

Returns:: true if there is a Gdk::Screen associcated with the widget.

void Gtk::Widget::hide ( )

Reverses the effects of show(), causing the widget to be hidden (invisible to the user).

void Gtk::Widget::hide_all ( )

Recursively hides a widget and any child widgets.

virtual void Gtk::Widget::hide_all_vfunc ( ) [protected, virtual]

void Gtk::Widget::input_shape_combine_mask	(	const Glib::RefPtr< const Gdk::Bitmap >&	shape_mask,
		int	offset_x,
		int	offset_y
	)

Sets an input shape for this widget's GDK window.

This allows for windows which react to mouse click in a nonrectangular region, see gdk_window_input_shape_combine_mask() for more information.

Since gtkmm 2.10:

Parameters:

	shape_mask	Shape to be added, or `0` to remove an existing shape.
	offset_x	X position of shape mask with respect to window.
	offset_y	Y position of shape mask with respect to window.

bool Gtk::Widget::intersect	(	const Gdk::Rectangle&	area,
		Gdk::Rectangle&	intersection
	)			const

Computes the intersection of a widget's area and area, storing the intersection in intersection, and returns true if there was an intersection.

intersection may be 0 if you're only interested in whether there was an intersection.

Parameters:

	area	A rectangle.
	intersection	Rectangle to store intersection of widget and area.

Returns:: true if there was an intersection.

bool Gtk::Widget::intersect ( const Gdk::Rectangle& area ) const

bool Gtk::Widget::is_ancestor ( Widget& ancestor ) const

Determines whether widget is somewhere inside ancestor, possibly with intermediate containers.

Parameters:

ancestor

Another Gtk::Widget.

Returns:: true if ancestor contains widget as a child, grandchild, great grandchild, etc.

bool Gtk::Widget::is_composite_child ( ) const

Returns trye if the widget is a composite child of its parent.

Deprecated:: Use the "composite-child" property instead.

bool Gtk::Widget::is_composited ( ) const

Whether widget can rely on having its alpha channel drawn correctly.

On X11 this function returns whether a compositing manager is running for widget's screen.

Please note that the semantics of this call will change in the future if used on a widget that has a composited window in its hierarchy (as set by gdk_window_set_composited()).

Since gtkmm 2.10:

Returns:: true if the widget can rely on its alpha channel being drawn correctly.

bool Gtk::Widget::is_drawable ( ) const

Deprecated:: : Use get_is_drawable() instead.

bool Gtk::Widget::is_focus ( ) const

Determines if the widget is the focus widget within its toplevel.

(This does not mean that the HAS_FOCUS flag is necessarily set; HAS_FOCUS will only be set if the toplevel widget additionally has the global input focus.)

Returns:: true if the widget is the focus widget.

bool Gtk::Widget::is_mapped ( ) const

Deprecated:: Use get_mapped() instead.

bool Gtk::Widget::is_realized ( ) const

Deprecated:: Use get_realized() instead.

bool Gtk::Widget::is_sensitive ( ) const

Returns the widget's effective sensitivity, which means it is sensitive itself and also its parent widget is sensntive.

Since gtkmm 2.18:

Returns:: true if the widget is effectively sensitive.

bool Gtk::Widget::is_toplevel ( ) const

Deprecated:: : Use get_is_toplevel() instead.

Reimplemented in Gtk::Window.

bool Gtk::Widget::is_visible ( ) const

Deprecated:: : Use get_visible() instead.

bool Gtk::Widget::keynav_failed ( DirectionType direction )

This function should be called whenever keyboard navigation within a single widget hits a boundary.

The function emits the Gtk::Widget::keynav-failed signal on the widget and its return value should be interpreted in a way similar to the return value of child_focus():

When true is returned, stay in the widget, the failed keyboard navigation is Ok and/or there is nowhere we can/should move the focus to.

When false is returned, the caller should continue with keyboard navigation outside the widget, e.g. by calling child_focus() on the widget's toplevel.

The default keynav-failed handler returns true for Gtk::DIR_TAB_FORWARD and Gtk::DIR_TAB_BACKWARD. For the other values of Gtk::DirectionType, it looks at the Gtk::Settings:gtk-keynav-cursor-only setting and returns false if the setting is true. This way the entire user interface becomes cursor-navigatable on input devices such as mobile phones which only have cursor keys but no tab key.

Whenever the default handler returns true, it also calls error_bell() to notify the user of the failed keyboard navigation.

A use case for providing an own implementation of keynav-failed (either by connecting to it or by overriding it) would be a row of Gtk::Entry widgets where the user should be able to navigate the entire row with the cursor keys, as e.g. known from user interfaces that require entering license keys.

Since gtkmm 2.12:

Parameters:

direction

Direction of focus movement.

Returns:: 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).

Glib::ListHandle<const Widget*> Gtk::Widget::list_mnemonic_labels ( ) const

Returns a newly allocated list of the widgets, normally labels, for which this widget is a the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()).

The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you <emphasis>must</emphasis> call <literal>g_list_foreach (result, (GFunc)g_object_ref, 0)</literal> first, and then unref all the widgets afterwards.

Since gtkmm 2.4:

Returns:: The list of mnemonic labels; free this list with Glib::list_free() when you are done with it.

Glib::ListHandle<Widget*> Gtk::Widget::list_mnemonic_labels ( )

Returns a newly allocated list of the widgets, normally labels, for which this widget is a the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()).

The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you <emphasis>must</emphasis> call <literal>g_list_foreach (result, (GFunc)g_object_ref, 0)</literal> first, and then unref all the widgets afterwards.

Since gtkmm 2.4:

Returns:: The list of mnemonic labels; free this list with Glib::list_free() when you are done with it.

void Gtk::Widget::map ( )

This function is only for use in widget implementations.

Causes a widget to be mapped if it isn't already.

bool Gtk::Widget::mnemonic_activate ( bool group_cycling )

Emits the Gtk::Widget::mnemonic-activate signal.

The default handler for this signal activates the widget if group_cycling is false, and just grabs the focus if group_cycling is true.

Parameters:

group_cycling true if there are other widgets with the same mnemonic.

Returns:: true if the signal has been handled.

void Gtk::Widget::modify_base	(	StateType	state,
		const Gdk::Color&	color
	)

Sets the base color for a widget in a particular state.

All other style values are left untouched. The base color is the background color used along with the text color (see modify_text() ) for widgets such as Gtk::Entry and Gtk::TextView. See also modify_style() and unset_base().

Parameters:

	state	The state for which to set the text color.
	color	The color to assign (does not need to be allocated).

void Gtk::Widget::modify_bg	(	StateType	state,
		const Gdk::Color&	color
	)

Sets the background color for a widget in a particular state.

All other style values are left untouched. See also modify_style() and unset_bg().

Parameters:

	state	The state for which to set the background color.
	color	The color to assign (does not need to be allocated).

void Gtk::Widget::modify_bg_pixmap	(	StateType	state,
		const Glib::ustring &	pixmap_name
	)

void Gtk::Widget::modify_cursor	(	const Gdk::Color&	primary,
		const Gdk::Color&	secondary
	)

Sets the cursor color to use in a widget, overriding the cursor_color and secondary_cursor_color style properties.

All other style values are left untouched. See also modify_style(). See also unset_cursor().

Parameters:

	primary	the color to use for primary cursor (does not need to be allocated).
	secondary	the color to use for secondary cursor (does not need to be allocated).

Since gtkmm 2.12:

void Gtk::Widget::modify_fg	(	StateType	state,
		const Gdk::Color&	color
	)

Sets the foreground color for a widget in a particular state.

All other style values are left untouched. See also modify_style() and unset_fg().

Parameters:

	state	The state for which to set the foreground color.
	color	The color to assign (does not need to be allocated).

void Gtk::Widget::modify_font ( const Pango::FontDescription & font_desc )

Sets the font to use for a widget.

All other style values are left untouched. See also modify_style() and unset_font().

void Gtk::Widget::modify_style ( const Glib::RefPtr< RcStyle >& style )

Modifies style values on the widget.

Modifications made using this technique take precedence over style values set via an RC file, however, they will be overriden if a style is explicitely set on the widget using set_style(). The Gtk::RcStyle structure is designed so each field can either be set or unset, so it is possible, using this function, to modify some style values and leave the others unchanged.

Note that modifications made with this function are not cumulative with previous calls to modify_style() or with such functions as modify_fg(). If you wish to retain previous values, you must first call get_modifier_style(), make your modifications to the returned style, then call modify_style() with that style. On the other hand, if you first call modify_style(), subsequent calls to such functions modify_fg() will have a cumulative effect with the initial modifications.

Parameters:

style

The Gtk::RcStyle holding the style modifications.

void Gtk::Widget::modify_text	(	StateType	state,
		const Gdk::Color&	color
	)

Sets the text color for a widget in a particular state.

All other style values are left untouched. The text color is the foreground color used along with the base color (see modify_base() ) for widgets such as Gtk::Entry and Gtk::TextView. See also modify_style() and unset_text().

Parameters:

	state	The state for which to set the text color.
	color	The color to assign (does not need to be allocated).

virtual bool Gtk::Widget::on_button_press_event ( GdkEventButton * event ) [protected, virtual]

virtual bool Gtk::Widget::on_button_release_event ( GdkEventButton * event ) [protected, virtual]

virtual void Gtk::Widget::on_child_notify ( GParamSpec * pspec ) [protected, virtual]

virtual bool Gtk::Widget::on_client_event ( GdkEventClient * event ) [protected, virtual]

virtual bool Gtk::Widget::on_configure_event ( GdkEventConfigure * event ) [protected, virtual]

virtual bool Gtk::Widget::on_delete_event ( GdkEventAny * event ) [protected, virtual]

virtual void Gtk::Widget::on_direction_changed ( TextDirection direction ) [protected, virtual]

virtual void Gtk::Widget::on_drag_begin ( const Glib::RefPtr< Gdk::DragContext >& context ) [protected, virtual]

virtual void Gtk::Widget::on_drag_data_delete ( const Glib::RefPtr< Gdk::DragContext >& context ) [protected, virtual]

virtual void Gtk::Widget::on_drag_data_get	(	const Glib::RefPtr< Gdk::DragContext >&	context,
		SelectionData&	selection_data,
		guint	info,
		guint	time
	)			`[protected, virtual]`

virtual void Gtk::Widget::on_drag_data_received	(	const Glib::RefPtr< Gdk::DragContext >&	context,
		int	x,
		int	y,
		const SelectionData&	selection_data,
		guint	info,
		guint	time
	)			`[protected, virtual]`

virtual bool Gtk::Widget::on_drag_drop	(	const Glib::RefPtr< Gdk::DragContext >&	context,
		int	x,
		int	y,
		guint	time
	)			`[protected, virtual]`

virtual void Gtk::Widget::on_drag_end ( const Glib::RefPtr< Gdk::DragContext >& context ) [protected, virtual]

virtual void Gtk::Widget::on_drag_leave	(	const Glib::RefPtr< Gdk::DragContext >&	context,
		guint	time
	)			`[protected, virtual]`

virtual bool Gtk::Widget::on_drag_motion	(	const Glib::RefPtr< Gdk::DragContext >&	context,
		int	x,
		int	y,
		guint	time
	)			`[protected, virtual]`

virtual bool Gtk::Widget::on_enter_notify_event ( GdkEventCrossing * event ) [protected, virtual]

virtual bool Gtk::Widget::on_event ( GdkEvent * event ) [protected, virtual]

virtual bool Gtk::Widget::on_expose_event ( GdkEventExpose * event ) [protected, virtual]

virtual bool Gtk::Widget::on_focus ( DirectionType direction ) [protected, virtual]

virtual bool Gtk::Widget::on_focus_in_event ( GdkEventFocus * event ) [protected, virtual]

virtual bool Gtk::Widget::on_focus_out_event ( GdkEventFocus * event ) [protected, virtual]

virtual Glib::RefPtr<Atk::Object> Gtk::Widget::on_get_accessible ( ) [protected, virtual]

virtual void Gtk::Widget::on_grab_focus ( ) [protected, virtual]

virtual void Gtk::Widget::on_grab_notify ( bool was_grabbed ) [protected, virtual]

virtual void Gtk::Widget::on_hide ( ) [protected, virtual]

virtual void Gtk::Widget::on_hierarchy_changed ( Widget* previous_toplevel ) [protected, virtual]

virtual bool Gtk::Widget::on_key_press_event ( GdkEventKey * event ) [protected, virtual]

virtual bool Gtk::Widget::on_key_release_event ( GdkEventKey * event ) [protected, virtual]

virtual bool Gtk::Widget::on_leave_notify_event ( GdkEventCrossing * event ) [protected, virtual]

virtual void Gtk::Widget::on_map ( ) [protected, virtual]

virtual bool Gtk::Widget::on_map_event ( GdkEventAny * event ) [protected, virtual]

virtual bool Gtk::Widget::on_mnemonic_activate ( bool group_cycling ) [protected, virtual]

virtual bool Gtk::Widget::on_motion_notify_event ( GdkEventMotion * event ) [protected, virtual]

virtual bool Gtk::Widget::on_no_expose_event ( GdkEventAny * event ) [protected, virtual]

virtual void Gtk::Widget::on_parent_changed ( Widget* previous_parent ) [protected, virtual]

virtual bool Gtk::Widget::on_property_notify_event ( GdkEventProperty * event ) [protected, virtual]

virtual bool Gtk::Widget::on_proximity_in_event ( GdkEventProximity * event ) [protected, virtual]

virtual bool Gtk::Widget::on_proximity_out_event ( GdkEventProximity * event ) [protected, virtual]

virtual void Gtk::Widget::on_realize ( ) [protected, virtual]

virtual void Gtk::Widget::on_screen_changed ( const Glib::RefPtr< Gdk::Screen >& previous_screen ) [protected, virtual]

virtual bool Gtk::Widget::on_scroll_event ( GdkEventScroll * event ) [protected, virtual]

virtual bool Gtk::Widget::on_selection_clear_event ( GdkEventSelection * event ) [protected, virtual]

virtual void Gtk::Widget::on_selection_get	(	SelectionData&	selection_data,
		guint	info,
		guint	time
	)			`[protected, virtual]`

virtual bool Gtk::Widget::on_selection_notify_event ( GdkEventSelection * event ) [protected, virtual]

virtual void Gtk::Widget::on_selection_received	(	const SelectionData&	selection_data,
		guint	time
	)			`[protected, virtual]`

virtual bool Gtk::Widget::on_selection_request_event ( GdkEventSelection * event ) [protected, virtual]

virtual void Gtk::Widget::on_show ( ) [protected, virtual]

virtual void Gtk::Widget::on_size_allocate ( Allocation& allocation ) [protected, virtual]

virtual void Gtk::Widget::on_size_request ( Requisition* requisition ) [protected, virtual]

virtual void Gtk::Widget::on_state_changed ( Gtk::StateType previous_state ) [protected, virtual]

virtual void Gtk::Widget::on_style_changed ( const Glib::RefPtr< Gtk::Style >& previous_style ) [protected, virtual]

virtual void Gtk::Widget::on_unmap ( ) [protected, virtual]

virtual bool Gtk::Widget::on_unmap_event ( GdkEventAny * event ) [protected, virtual]

virtual void Gtk::Widget::on_unrealize ( ) [protected, virtual]

virtual bool Gtk::Widget::on_visibility_notify_event ( GdkEventVisibility * event ) [protected, virtual]

virtual bool Gtk::Widget::on_window_state_event ( GdkEventWindowState * event ) [protected, virtual]

bool Gtk::Widget::parent_sensitive ( ) const

Deprecated:: Call get_sensitive() on the result of get_parent() instead.

void Gtk::Widget::path	(	Glib::ustring &	path,
		Glib::ustring &	path_reversed
	)

Compute a widget's path of the form "GtkWindow.MyLabel".

static void Gtk::Widget::pop_colormap ( ) [static]

Removes a colormap pushed with push_colormap().

static void Gtk::Widget::pop_composite_child ( ) [static]

Cancels the effect of a previous call to push_composite_child().

Glib::PropertyProxy_ReadOnly<bool> Gtk::Widget::property_app_paintable ( ) const

Whether the application will paint directly on the widget.