Xfce Foundation Classes
Main Page  | IndexNamespace List  |  Alphabetical List  |  Class List  |  File List


Xfc::Gtk::Widget Class Reference

A GtkWidget C++ wrapper class. More...

#include <xfc/gtk/widget.hh>

Inheritance diagram for Xfc::Gtk::Widget:

Xfc::Gtk::Object Xfc::Atk::Implementor Xfc::G::Object Xfc::G::TypeInterface Xfc::G::TypeInstance Xfc::G::TypeInstance Xfc::Trackable Xfc::Trackable Xfc::Gtk::Calendar Xfc::Gtk::CellView Xfc::Gtk::Container Xfc::Gtk::DrawingArea Xfc::Gtk::Entry Xfc::Gtk::Invisible Xfc::Gtk::Misc Xfc::Gtk::ProgressBar Xfc::Gtk::Range Xfc::Gtk::Ruler Xfc::Gtk::Separator List of all members.

Basic Signal Prototypes

Selection Signal Prototypes

Drag Source-side Signal Prototypes

Drag Target-side Signal Prototypes

GDK Event Signal Prototypes

Public Member Functions

Accessors
Methods
Keyboard and Pointer Grab Methods
Selection Methods (from gtkselection.h)
Drag-and-Drop Target Methods (from gtkdnd.h)
Drag-and-Drop Source Methods (from gtkdnd.h)
Basic Signal Proxies
Selection Signal Proxies
Source-side Drag Signal Proxies
Target-side Drag Signal Proxies
GDK Event Signal Proxies

Static Public Member Functions

Accessors
Methods
Selection Methods (from gtkselection.h)

Protected Member Functions

Methods

Detailed Description

A GtkWidget C++ wrapper class.

Widget is the base class for widgets that make up the graphical user interface, such as windows, menus, buttons, scrollbars, editors, drawing areas, and so on.

After implementing a widget in your application you frequently need to set some widget-specific attributes, such as the widget's size, position, and so on. When the user interacts with a widget, such as pulling down a menu and making a selection, clicking a button, or moving a scrollbar, your application needs to respond by calling a callback slot that you supply. Callback slots are objects that call the class or static method that you want attached to a user action.

A parent-child relationship must be established between widgets in your application, such as by packing a button into a box or adding a menu item to a menu. These releationships provide management capabitilies and help determine the layout of the user interface. After widgets are created, parent-child relationships established, and callback slots attached you need to display the widgets. This is accomplished by calling show() on a widget, or show_all() on the parent widget to to show all the child widgets at once.

Any user action in you interface causes the corresponding widget to emit a signal, to which your callback slot has been attached. You can respond to these signals in two ways. The first way is to derive a new class from the widget, such as Gtk::Button, and override one or more of its inherited virutal signal handlers, such as on_clicked() for the button's "clicked" signal. Continuing with Gtk::Button, the second way is to create an instance of Gtk::Button and attach to it your clicked callback slot, by calling signal_clicked().connect(slot());

Widget implements this Atk::Implementor interface. Calling get_accessible() is the same as calling ref_accessible() inherited from Atk::Implementor, except ref_accessible() returns a smart pointer.

See also: the Widget, Composite Widget and Custom Widget HOWTOs and examples.


Constructor & Destructor Documentation

Xfc::Gtk::Widget::Widget ( GtkWidget *  widget,
bool  owns_reference = false 
) [explicit, protected]

Construct a new Widget from an existing GtkWidget.

Parameters:
widget A pointer to a GtkWidget.
owns_reference Set false if the initial reference count is floating, set true if it's not.
The widget can be a newly created GtkWidget or an existing GtkWidget (see G::Object::Object).

Xfc::Gtk::Widget::Widget ( GtkWidget *  widget,
bool  owns_reference = false 
) [explicit, protected]

Construct a new Widget from an existing GtkWidget.

Parameters:
widget A pointer to a GtkWidget.
owns_reference Set false if the initial reference count is floating, set true if it's not.
The widget can be a newly created GtkWidget or an existing GtkWidget (see G::Object::Object).


Member Function Documentation

void Xfc::Gtk::Widget::set_allocation ( const Allocation allocation  )  [protected]

Sets the position and size allocated to a child widget.

Parameters:
allocation The position and size to be allocated to the widget.
This method can be called from the widget's virtual on_size_request to set the allocation (see the Dial example program).

void Xfc::Gtk::Widget::set_window ( const Gdk::Window window  )  [protected]

Sets the Gdk::Window for the widget.

Parameters:
window A Gdk::Window.
This method only works if gtk_widget()->window is null. It is only for use when implementing a custom widget that derives directly from Gtk::Widget. After creating a Gdk::Window for the custom widget in the widget's virtual on_realize() method you should call this method to set the window. If the widget already has a Gdk::Window nothing happens (see the Dial example program).

bool Xfc::Gtk::Widget::get_no_show_all (  )  const

Returns the current value of the "no_show_all" property, which determines whether calls to show_all() and hide_all() will affect this widget.

Returns:
The current value of the "no_show_all" property.

Requisition Xfc::Gtk::Widget::get_child_requisition (  )  const

Obtains the child widget requisition (see get_child_requisition(Requisition&) const).

Returns:
A Requisition that holds the child widget's width and height.

void Xfc::Gtk::Widget::get_child_requisition ( Requisition requisition  )  const

Obtains the child widget requisition, unless someone has forced a particular geometry on the widget, in which case it returns that geometry instead of the widget's requisition.

Parameters:
requisition The Requisition to be filled in.
This method is only for use in widget implementations. It differs from size_request() in that it retrieves the last size request value from gtk_widget()->requisition, while size_request() actually calls the "size_request" method on the widget to compute the size request and fill in gtk_widget()->requisition, and only then returns gtk_widget()->requisition. Because this method does not call the "size_request" method, it can only be used when you know that gtk_widget()->requisition is up-to-date, that is, size_request() has been called since the last time a resize was queued. In general, only container implementations have this information; applications should use size_request().

bool Xfc::Gtk::Widget::is_focus (  )  const

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

Returns:
true if the widget is the focus widget.
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.

String Xfc::Gtk::Widget::get_name (  )  const

Retrieves the name of the widget (see set_name() for the significance of widget names).

Returns:
The name of the widget.

Reimplemented in Xfc::Gtk::AboutDialog.

bool Xfc::Gtk::Widget::get_child_visible (  )  const

Returns the value set with set_child_visible().

Returns:
true if the widget is mapped with the parent.
If you feel a need to use this method, your code probably needs reorganization. This method is only useful for container implementations and never should be called by an application.

void Xfc::Gtk::Widget::get_size_request ( int *  width,
int *  height 
) const

Gets the size request that was explicitly set for the widget using set_size_request().

Parameters:
width The return location for the width, or null.
height The return location for the height, or null.
A value of -1 stored in width or height indicates that that dimension has not been set explicitly and the natural requisition of the widget will be used intead. See set_size_request(). To get the size a widget will actually use, call size_request() instead of this method.

Widget* Xfc::Gtk::Widget::get_toplevel (  )  const

This method returns the topmost widget in the container hierarchy the widget is a part of.

Returns:
The topmost ancestor of widget, or widget itself if there's no ancestor.
If widget has no parent widgets, it will be returned as the topmost widget. No reference will be added to the returned widget; it should not be unreferenced. Note the difference in behavior vs get_ancestor(); get_ancestor(Gtk::TYPE_WINDOW) would return null if widget wasn't inside a toplevel window, and if the window was inside a Gtk::Window-derived widget which was in turn inside the toplevel Gtk::Window. While the second case may seem unlikely, it actually happens when a Plug is embedded inside a Socket within the same application.

To reliably find the toplevel Gtk::Window, use get_toplevel() and check is_top_level() on the result.

< Gtk::Widget *toplevel = widget->get_toplevel();
< if (is_toplevel())
< {
<       // Perform action on toplevel.
< }
<

Widget* Xfc::Gtk::Widget::get_ancestor ( GType  widget_type  )  const

Gets the first ancestor of widget with type widget_type.

Parameters:
widget_type The ancestor type.
Returns:
The ancestor widget, or null if not found.
For example, get_ancestor(GTK_TYPE_BOX) gets the first Box that's an ancestor of the widget. No reference will be added to the returned widget; it should not be unreferenced. See note about checking for a toplevel Gtk::Window in the docs for get_toplevel().

Gdk::Colormap* Xfc::Gtk::Widget::get_colormap (  )  const

Returns the colormap that will be used to render the widget.

No reference will be added to the returned colormap; it should not be unreferenced.

Gdk::Screen* Xfc::Gtk::Widget::get_screen (  )  const

Get the Gdk::Screen from the toplevel window associated with this widget.

Returns:
The Gdk::Screen for the toplevel for this widget.
This function can only be called after the widget has been added to a widget hierarchy with a Gtk::Window at the top. In general, you should only create screen specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.

Reimplemented in Xfc::Gtk::Invisible, and Xfc::Gtk::Window.

bool Xfc::Gtk::Widget::has_screen (  )  const

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

Returns:
true if there is a Gdk::Screen associcated with the widget.
All toplevel widgets have an associated screen, as do all widgets added into a heirarchy with a toplevel window at the top.

Gdk::Display* Xfc::Gtk::Widget::get_display (  )  const

Get the Gdk::Display for the toplevel window associated with this widget.

Returns:
The Gdk::Display for the toplevel for this widget.
This method can only be called after the widget has been added to a widget hierarchy with a Gtk::Window at the top. In general, you should only create display specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.

Gdk::Window* Xfc::Gtk::Widget::get_root_window (  )  const

The root window is useful for such purposes as creating a popup Gdk::Window associated with the window.

Returns:
The Gdk::Window root window for the toplevel for this widget.
In general, you should only create display specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.

Settings* Xfc::Gtk::Widget::get_settings (  )  const

Gets the settings object holding the settings (global property settings, RC file information, etc) used for this widget.

Returns:
The relevant Settings object.
Note that this method can only be called when the Widget is attached to a toplevel, since the settings object is specific to a particular Gdk::Screen.

Clipboard* Xfc::Gtk::Widget::get_clipboard ( Gdk::Atom  selection = GDK_SELECTION_CLIPBOARD  )  const

Returns the clipboard object for the given selection to be used with widget.

Parameters:
selection A Gdk::Atom which identifies the clipboard to use.
Returns:
The appropriate clipboard object.
The widget must have a Gdk::Display associated with it, and so must be attached to a toplevel window. GDK_SELECTION_CLIPBOARD gives the default clipboard. Another common value is GDK_SELECTION_PRIMARY, which gives the primary X selection. If no clipboard already exists, a new one will be created. Once a clipboard object has been created, it is persistent for all time. All clipboard objects are owned by GTK+ and will be freed when GTK+ is removed from memory.

Gdk::EventMaskField Xfc::Gtk::Widget::get_events (  )  const

Gets the event mask for the widget (a bitfield containing flags from the Gdk::EventMask enumeration).

Returns:
The event mask for the widget.
These are the events that the widget will receive.

void Xfc::Gtk::Widget::get_pointer ( int *  x,
int *  y 
) const

Obtains the location of the mouse pointer in widget coordinates.

Parameters:
x The return location for the X coordinate, or null.
y The return location for the Y coordinate, or null.
Widget coordinates are a bit odd; for historical reasons, they are defined as Gdk::Window coordinates for widgets that are not Gtk::NO_WINDOW widgets, and are relative to get_allocation().x and get_allocation().y for widgets that are Gtk::NO_WINDOW widgets.

Gdk::Point Xfc::Gtk::Widget::get_pointer (  )  const

Obtains the location of the mouse pointer in widget coordinates.

Returns:
The widget coordinates stored in a Gdk::Point.
Widget coordinates are a bit odd; for historical reasons, they are defined as Gdk::Window coordinates for widgets that are not Gtk::NO_WINDOW widgets, and are relative to get_allocation().x and get_allocation().y for widgets that are Gtk::NO_WINDOW widgets.

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

Determines whether the widget is somewhere inside ancestor, possibly within an intermediate container.

Parameters:
ancestor Another Widget.
Returns:
true if ancestor contains the widget as a child, grandchild, great grandchild, etc.

Style* Xfc::Gtk::Widget::rc_get_style (  )  const

Finds all matching RC styles for a given widget, composites them together, and then creates a Style representing the composite appearance.

Returns:
The resulting style. No refcount is added to the returned style, so if you want to keep this style around, you should add a reference yourself.
GTK+ actually keeps a cache of previously created styles, so a new style may not be created.

RcStyle* Xfc::Gtk::Widget::get_modifier_style (  )  const

Returns the current modifier style for the widget (as set by modify_style()).

If no style has previously set, a new RcStyle will be created with all values unset, and set as the modifier style for the widget. If you make changes to this rc style, you must call modify_style(), passing in the returned rc style, to make sure that your changes take effect.

Caution: passing the style back to modify_style() will normally end up destroying it, because modify_style() copies the passed-in style and sets the copy as the new modifier style, thus dropping any reference to the old modifier style. Add a reference to the modifier style if you want to keep it alive.

Pango::Context* Xfc::Gtk::Widget::get_pango_context (  )  const

Returns a Pango::Context with the appropriate colormap, font description and base direction for the widget.

Unlike the context returned by create_pango_context(), this context is owned by the widget (it can be used as long as widget exists), and will be updated to match any changes to the widget's attributes.

If you create and keep a Pango::Layout using this context, you must deal with changes to the context by calling Pango::Layout::context_changed() on the layout in response to the style_set and direction_set signals for the widget.

void Xfc::Gtk::Widget::style_get_property ( const String property_name,
G::Value value 
)

Gets the value of a style property of the widget.

Parameters:
property_name The name of a style property.
value The location to return the property value.

void Xfc::Gtk::Widget::path ( String path,
String path_reversed 
) const

Obtains the full path to the widget.

Parameters:
path The location to store the path string, or null.
path_reversed The location to store path string, or null.
The path is simply the name of a widget and all its parents in the container hierarchy, separated by periods. The name of a widget comes from get_name(). Paths are used to apply styles to a widget in gtkrc configuration files. Widget names are the type of the widget by default (e.g. "Button") or can be set to an application-specific value with set_name(). By setting the name of a widget, you allow users or theme authors to apply styles to that specific widget in their gtkrc file. path_reversed fills in the path in reverse order, i.e. starting with widget's name instead of starting with the name of widget's outermost ancestor.

void Xfc::Gtk::Widget::class_path ( String path,
String path_reversed 
) const

Same as path(), but always uses the name of a widget's type, never uses a custom name set with set_name().

Parameters:
path The location to store the path string, or null.
path_reversed The location to store path string, or null.

static const Style* Xfc::Gtk::Widget::get_default_style (  )  [static]

Returns the default style used by all widgets initially.

Returns:
The default style. This Style object is owned by GTK+ and should not be modified or unreferenced.

static const Gdk::Visual* Xfc::Gtk::Widget::get_default_visual (  )  [static]

Returns the visual of the default colormap.

Not really useful; used to be useful before Gdk::Colormap::get_visual() existed.

void Xfc::Gtk::Widget::set_flags ( WidgetFlagsField  flags  ) 

Turns on certain widget flags.

Parameters:
flags The Gtk::WidgetFlags to set.

void Xfc::Gtk::Widget::unset_flags ( WidgetFlagsField  flags  ) 

Turns off certain widget flags.

Parameters:
flags The Gtk::WidgetFlags to unset.

void Xfc::Gtk::Widget::show (  ) 

Flags a widget to be displayed.

Any widget that isn't shown will not appear on the screen. If you want to show all the widgets in a container, it's easier to call widget_show_all() on the container, instead of individually showing the widgets.

Remember that you have to show the container containing a widget, in addition to the widget itself, before it will appear onscreen. When a toplevel container is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel container is realized and mapped.

void Xfc::Gtk::Widget::show ( bool  visible  ) 

Convenience method that combines the functionality of show() and hide().

Parameters:
visible Set true to show the widget, or false to hide it.
This method is useful when you want to use another boolean value to toggle the visibility of this widget.

void Xfc::Gtk::Widget::show_now (  ) 

Shows a widget.

If the widget is an unmapped toplevel widget (i.e. a Gtk::Window that has not yet been shown), enter the main loop and wait for the window to actually be mapped. Be careful; because the main loop is running, anything can happen during this method.

void Xfc::Gtk::Widget::set_no_show_all ( bool  no_show_all  ) 

Sets the "no_show_all" property, which determines whether calls to show_all() and hide_all() will affect this widget.

Parameters:
no_show_all The new value for the "no_show_all" property.
This is mostly for use in constructing widget hierarchies with externally controlled visibility, see Gtk::UIManager.

void Xfc::Gtk::Widget::realize (  ) 

Creates the GDK (windowing system) resources associated with a widget.

For example, a widget's GDK window will be created when a widget is realized. Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized and mapped automatically. Realizing a widget requires all the widget's parent widgets to be realized. Calling realize() realizes the widget's parents in addition to widget itself. If a widget is not yet inside a toplevel window when you realize it, bad things will happen.

This method is primarily used in widget implementations, and isn't very useful otherwise. Many times when you think you might need it, a better approach is to connect to a signal that will be called after the widget is realized automatically, such as expose_event signal. Or simply connect to the realize signal specifying after as true in the signal's connect method.

void Xfc::Gtk::Widget::queue_draw_area ( int  x,
int  y,
int  width,
int  height 
)

Invalidates the rectangular area of the widget defined by x, y, width and height by calling Gdk::Window::invalidate_rect() on the widget's window and all its child windows.

Parameters:
x The X coordinate of upper-left corner of rectangle to redraw.
y The Y coordinate of upper-left corner of rectangle to redraw
width The width of region to draw.
height The height of region to draw.
Once the main loop becomes idle (after the current batch of events has been processed, roughly), the window will receive expose events for the union of all regions that have been invalidated.

Normally you would only use this method in widget implementations. You might also use it, or Gdk::Window::invalidate_rect() directly, to schedule a redraw of a DrawingArea or some portion thereof. Frequently you can just call Gdk::Window::invalidate_rect() or Gdk::Window::invalidate_region() instead of this method. Those methods will invalidate only a single window, instead of the widget and all its children.

The advantage of adding to the invalidated region compared to simply drawing immediately is efficiency; using an invalid region ensures that you only have to redraw one time.

void Xfc::Gtk::Widget::queue_draw_area ( const Gdk::Rectangle rectangle  ) 

Invalidates the rectangular area of the widget defined by rectangle by calling Gdk::Window::invalidate_rect() on the widget's window and all its child windows.

Parameters:
rectangle A rectangle that specifies the area of the widget to invalidate.

void Xfc::Gtk::Widget::queue_resize (  ) 

This method is only for use in widget implementations.

Flags a widget to have its size renegotiated; should be called when a widget for some reason has a new size request. For example, when you change the text in a Label, Label queues a resize to ensure there's enough space for the new text.

void Xfc::Gtk::Widget::size_request ( Requisition requisition  ) 

Typically used when implementing a Container subclass; obtains the preferred size of the widget.

Parameters:
requisition A Requisition to be filled in.
The container uses this information to arrange its child widgets and decide what size allocations to give them with size_allocate().

You can also call this function from an application, with some caveats. Most notably, getting a size request requires the widget to be associated with a screen, because font information may be needed. Multihead-aware applications should keep this in mind. Also remember that the size request is not necessarily the size a widget will actually be allocated. See also get_child_requisition().

void Xfc::Gtk::Widget::size_allocate ( const Allocation allocation  ) 

This method is only used by Container subclasses to assign a size and position to their child widgets.

Parameters:
allocation The position and size to be allocated to the widget.

void Xfc::Gtk::Widget::add_accelerator ( const String accel_signal,
AccelGroup accel_group,
const AccelKey accel_key 
)

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

Parameters:
accel_signal The widget signal to emit on accelerator activation.
accel_group The accelerator group for this widget, added to its toplevel.
accel_key An AccelKey that holds the accelerator key, modifier and flag values.
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 G_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.

bool Xfc::Gtk::Widget::remove_accelerator ( AccelGroup accel_group,
const AccelKey accel_key 
)

Removes an accelerator from the widget previously installed with add_accelerator().

Parameters:
accel_group The accel group for this widget.
accel_key An AccelKey that holds the accelerator key, modifier and flag values.
Returns:
Whether an accelerator was installed and could be removed.

void Xfc::Gtk::Widget::set_accel_path ( const String accel_path,
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, the widget will be activated.

Parameters:
accel_path The path used to look up the the accelerator.
accel_group The accelerator group.
This removes any accelerators (for any accelerator group) installed by previous calls to set_accel_path(). Associating accelerators with paths allows them to be modified by the user and the modifications to be saved for future use. (See Gtk::AccelMap_save().)

This method is a low level function that would most likely be used by a menu creation system like ItemFactory. If you use ItemFactory, setting up accelerator paths will be done automatically. Even when you you aren't using ItemFactory, if you only want to set up accelerators on menu items Gtk::MenuItem::set_accel_path() provides a somewhat more convenient interface.

bool Xfc::Gtk::Widget::list_accel_closures ( std::vector< GClosure * > &  closures  ) 

Lists the closures used by the widget for accelerator group connections with Gtk::AccelGroup::connect().

/* T

Parameters:
closures A reference to a vector of GClosure* to hold the list of closures.
Returns:
true if the vector is not empty.
The closures can be used to monitor accelerator changes on the widget, by connecting to the accel_changed signal of the AccelGroup of a closure, which can be found out with Gtk::AccelGroup::from_accel_closure().

bool Xfc::Gtk::Widget::can_activate_accel ( unsigned int  signal_id  ) 

Determines whether an accelerator that activates the signal identified by signal_id can currently be activated.

Parameters:
signal_id The id of a signal installed on the widget.
Returns:
true if the accelerator can be activated.
The determination is made by emitting the can_activate_accel signal on the widget. If the signal isn't overridden by a handler or in a derived widget, then the default check is that the widget must be sensitive, and the widget and all its parents mapped.

bool Xfc::Gtk::Widget::can_activate_accel ( const String signal_name  ) 

Determines whether an accelerator that activates the signal identified by signal_name can currently be activated (see can_activate_accel(unsigned int)).

Parameters:
signal_name The name of a signal installed on the widget.
Returns:
true if the accelerator can be activated.

int Xfc::Gtk::Widget::send_expose ( const Gdk::EventExpose event  ) 

This rarely-used method is used to emit an expose_event signal on the widget.

Parameters:
event A Gdk::GdkEventExpose.
Returns:
The return from the event signal emission (true if the event was handled).
This method is not normally used directly. The only time it is used is when propagating an expose event to a child NO_WINDOW widget, and that is normally done using Gtk::Container::propagate_expose().

If you want to force an area of a window to be redrawn, use Gdk::Window::invalidate_rect() or Gdk::Window::invalidate_region(). To cause the redraw to be done immediately, follow that call with a call to Gdk::Window::process_updates().

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

Actviates the widget if it's suitable for mnemonic actviaton.

Parameters:
group_cycling 
Returns:
true if the widget was activated.

bool Xfc::Gtk::Widget::event ( const Gdk::Event event  ) 

This rarely-used method is used to emit the event signals on a widget (those signals should never be emitted without using this method to do so).

Parameters:
event A Gdk::Event.
Returns:
The return from the event signal emission (true if the event was handled).
If you want to synthesize an event though, don't use this function; instead, use gtk_main_do_event() so the event will behave as if it were in the event queue. Don't synthesize expose events; instead, use Gdk::Window::invalidate_rect() to invalidate a region of the window.

bool Xfc::Gtk::Widget::activate (  ) 

For widgets that can be activated (buttons, menu items, etc) this method activates them.

Returns:
true if the widget was activatable.
Activation is what happens when you press Enter on a widget during key navigation; clicking a button, selecting a menu item, etc. If the widget isn't activatable, this method returns false.

Reimplemented in Xfc::Gtk::MenuItem.

bool Xfc::Gtk::Widget::set_scroll_adjustments ( Adjustment hadjustment,
Adjustment vadjustment 
)

Sets the widget's scroll adjustments.

Parameters:
hadjustment An adjustment for horizontal scrolling, or null.
vadjustment An adjustment for vertical scrolling, or null.
Returns:
true if the widget supports scrolling.
For widgets that support scrolling, sets the scroll adjustments and returns true. For widgets that don't support scrolling, does nothing and returns false. Widgets that don't support scrolling can be scrolled by placing them in a Viewport, which does support scrolling.

void Xfc::Gtk::Widget::reparent ( Widget new_parent  ) 

Moves a widget from one Container to another, handling reference count issues to avoid destroying the widget.

Parameters:
new_parent A Container to move the widget into.

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

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

Parameters:
area A rectangle.
intersection The rectangle to store intersection of the widget and area.
Returns:
true if there was an intersection.
The intersection may be null if you're only interested in whether there was an intersection.

Gdk::Rectangle Xfc::Gtk::Widget::intersect ( const Gdk::Rectangle area  ) 

Computes the intersection of a widget's area and area, and returns the intersection as a rectanlge.

that stores .

Parameters:
area A rectangle.
Returns:
A rectangle storing the intersection if there was an intersection.
The returned rectangle will be empty if there was no intersection.

Pointer<Gdk::Region> Xfc::Gtk::Widget::intersect ( Gdk::Region region  ) 

Computes the intersection of a widget's area and region, and returns the intersection as a new Gdk::Region.

Parameters:
region a Gdk::Region.
Returns:
A smart pointer to a new Gdk::Region holding the intersection of the widget and region.
region must be in the same coordinate system as the widget's allocation. That is, relative to the widget's GDK window for NO_WINDOW widgets; relative to the parent window of widget's GDK window for widgets with their own window. The coordinates returned are relative to the widget's GDK window for NO_WINDOW widgets, and relative to the parent window of widget's GDK window for widgets with their own window. The returned region may be empty, use Gdk::Region::empty() to check.

void Xfc::Gtk::Widget::freeze_child_notify (  ) 

Stops the emission of child_notify signals on the widget.

The signals are queued until thaw_child_notify() is called on the widget.

void Xfc::Gtk::Widget::child_notify ( const String child_property  ) 

Emits a child_notify signal for the child property child_property on the widget.

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

void Xfc::Gtk::Widget::thaw_child_notify (  ) 

Reverts the effect of a prevoious call to freeze_child_notify().

This causes all queued child_notify signals on widget to be emitted.

void Xfc::Gtk::Widget::grab_focus (  ) 

Causes the widget to have the keyboard focus for the Window it's inside.

The widget must be a focusable widget, such as an Entry; something like Frame won't work. More precisely, it must have the Gtk::CAN_FOCUS flag set.

void Xfc::Gtk::Widget::grab_default (  ) 

Causes the widget to become the default widget.

The widget must have the Gtk::CAN_DEFAULT flag set; typically you have to set this flag yourself by calling set_flags(Gtk::CAN_DEFAULT). The default widget is activated when the user presses Enter in a window. Default widgets must be activatable, that is, activate() should affect them.

void Xfc::Gtk::Widget::set_name ( const String name  ) 

Widgets can be named, which allows you to refer to them in a gtkrc file.

Parameters:
name The name for the widget.
You can apply a style to widgets with a particular name in the gtkrc file. See the GTK+ documentation for gtkrc files (on the same page as the docs for GtkRcStyle).

Reimplemented in Xfc::Gtk::AboutDialog.

void Xfc::Gtk::Widget::set_state ( StateType  state  ) 

Used in widget implementations; sets the state of the widget (insensitive, prelighted, etc).

Parameters:
state The new state for the widget.
Usually you should set the state using wrapper functions such as set_sensitive().

void Xfc::Gtk::Widget::set_sensitive ( bool  sensitive  ) 

Sets the sensitivity of the widget.

Parameters:
sensitive true to make the widget sensitive.
A widget is sensitive if the user can interact with it. Insensitive widgets are grayed out and the user can't interact with them. Insensitive widgets are known as inactive, disabled, or ghosted in some other toolkits.

void Xfc::Gtk::Widget::set_app_paintable ( bool  app_paintable  ) 

Sets the Gtk::APP_PAINTABLE flags on the widget.

Parameters:
app_paintable true if Gtk::APP_PAINTABLE should be set.
Must be set on widgets whose window the application directly draws on, in order to keep GTK+ from overwriting the drawn stuff.

void Xfc::Gtk::Widget::set_double_buffered ( bool  double_buffered  ) 

Widgets are double buffered by default; you can use this function to turn off the buffering.

Parameters:
double_buffered true to double-buffer a widget.
Double buffered simply means that Gdk::Window::begin_paint() and Gdk::Window::end_paint() are called automatically around expose events sent to the widget. Gdk::Window::begin_paint() diverts all drawing to a widget's window to an offscreen buffer, and Gdk::Window::end_paint() draws the buffer to the screen. The result is that users see the window update in one smooth step, and don't see individual graphics primitives being rendered. In very simple terms, double buffered widgets don't flicker, so you would only use this function to turn off double buffering if you had special needs and really knew what you were doing.

void Xfc::Gtk::Widget::set_redraw_on_allocate ( bool  redraw_on_allocate  ) 

When a widgets size allocation changes, sets whether the entire widget is queued for drawing or not.

Parameters:
redraw_on_allocate Set true to redraw the entire widget when it's resized, and false to only redraw the new portion of the widget
By default, this setting is true and the entire widget is redrawn on every size change. If your widget leaves the upper left unchanged when made bigger, turning this setting on will improve performance. Note that for NO_WINDOW widgets setting this flag to false turns off all allocation on resizing: the widget will not even redraw if its position changes; this is to allow containers that don't draw anything to avoid excess invalidations. If you set this flag on a NO_WINDOW widget that does draw on the widget's GDK window, you are responsible for invalidating both the old and new allocation of the widget when the widget is moved and responsible for invalidating regions newly when the widget increases size.

void Xfc::Gtk::Widget::set_parent ( Widget parent  ) 

Sets the container as the parent of widget, and takes care of some details such as updating the state and style of the child to reflect its new location.

Parameters:
parent The parent container.
This method is useful only when implementing subclasses of Container. The opposite method is unparent().

void Xfc::Gtk::Widget::set_parent_window ( Gdk::Window parent_window  ) 

Sets a non default parent window for widget.

Parameters:
parent_window The new parent window.

void Xfc::Gtk::Widget::set_child_visible ( bool  is_visible  ) 

Sets whether the widget should be mapped along with its parent when its parent is mapped and the widget has been shown with show().

Parameters:
is_visible If true, the widget should be mapped along with its parent.
The child visibility can be set for a widget before it is added to a container with set_parent(), to avoid mapping children unnecessary before immediately unmapping them. However it will be reset to its default state of true when the widget is removed from a container.

Note that changing the child visibility of a widget does not queue a resize on the widget. Most of the time, the size of a widget is computed from all visible children, whether or not they are mapped. If this is not the case, the container can queue a resize itself. This method is only useful for container implementations and never should be called by an application.

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

Moves the focus to the child widget.

Parameters:
direction The direction of focus movement.
Returns:
true if the focus ended up inside the widget.
This method is used by custom widget implementations; if you're writing an application, 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 methods 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() invokes the "focus" signal on the Widget; widgets override the default handler for this signal in order to implement appropriate focus behavior. The "focus" default 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.

void Xfc::Gtk::Widget::set_size_request ( int  width,
int  height 
)

Sets the minimum size of a widget; that is, the widget's size request will be width by height.

Parameters:
width The width the widget should request, or -1 to unset.
height The height widget should request, or -1 to unset.
You can use this method to force a widget to be either larger or smaller than it normally would be. In most cases, set_default_size() is a better choice for toplevel windows than this method; setting the default size will still allow users to shrink the window. Setting the size request will force them to leave the window at least as large as the size request. When dealing with window sizes, Gtk::Window::set_geometry_hints() can be a useful method as well.

Note the inherent danger of setting any fixed size - themes, translations into other languages, different fonts, and user action can all change the appropriate size for a given widget. So, it's basically impossible to hardcode a size that will always be correct.

The size request of a widget is the smallest size a widget can accept while still functioning well and drawing itself correctly. However in some strange cases a widget may be allocated less than its requested size, and in many cases a widget may be allocated more space than it requested. If the size request in a given direction is -1 (unset), then the "natural" size request of the widget will be used instead. Widgets can't actually be allocated a size less than 1 by 1, but you can pass 0,0 to this function to mean "as small as possible."

void Xfc::Gtk::Widget::set_events ( Gdk::EventMaskField  events  ) 

Sets the event mask (see Gdk::EventMask) for a widget.

Parameters:
events The event mask.
The event mask determines which events a widget will receive. Keep in mind that different widgets have different default event masks, and by changing the event mask you may disrupt a widget's functionality, so be careful. This method must be called while a widget is unrealized. Consider add_events() for widgets that are already realized, or if you want to preserve the existing event mask. This method can't be used with Gtk::NO_WINDOW widgets; to get events on those widgets, place them inside an EventBox and receive events on the event box.

void Xfc::Gtk::Widget::add_events ( Gdk::EventMaskField  events  ) 

Adds the events in the bitfield events to the event mask for the widget (see set_events()).

Parameters:
events An event mask, see Gdk::EventMask.

void Xfc::Gtk::Widget::set_extension_events ( Gdk::ExtensionMode  mode  ) 

Sets the extension events mask to mode (see Gdk::ExtensionMode and Gdk::Input::set_extension_events()).

Parameters:
mode The extension events to receive.

void Xfc::Gtk::Widget::set_colormap ( Gdk::Colormap colormap  ) 

Sets the colormap for the widget to colormap.

Parameters:
colormap A colormap.
The widget must not have been previously realized. This probably should only be used from a constructor for the widget.

bool Xfc::Gtk::Widget::translate_coordinates ( Widget src_widget,
int  src_x,
int  src_y,
int *  dest_x,
int *  dest_y 
) const

Translate coordinates relative to src_widget's allocation to coordinates relative to this widget's allocation.

Parameters:
src_widget The source widget.
src_x The X position relative to src_widget.
src_y The Y position relative to src_widget.
dest_x The location to store X position relative to this widget.
dest_y The location to store Y position relative to this widget.
Returns:
false if either widget was not realized, or there was no common ancestor. In this case, nothing is stored in dest_x and dest_y. Otherwise true.
In order to perform this operation, both widgets must be realized, and must share a common toplevel.

void Xfc::Gtk::Widget::set_style ( Style style  ) 

Sets the Style for the widget.

Parameters:
style A Gtk::Style, or null to remove the effect of a previous set_style() and go back to the default style.
You probably don't want to use this function; it interacts badly with themes, because themes work by replacing the Style. Instead, use modify_style().

void Xfc::Gtk::Widget::ensure_style (  ) 

Ensures that the widget has a style.

Not a very useful method; most of the time, if you want the style, the widget is realized, and realized widgets are guaranteed to have a style already.

void Xfc::Gtk::Widget::modify_style ( RcStyle style  ) 

Modifies style values on the widget.

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

Note that modifications made with this method 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 methods as modify_fg() will have a cumulative effect with the initial modifications.

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

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

Parameters:
state The state for which to set the foreground color.
color The color to assign (does not need to be allocated), or null to undo the effect of previous calls to modify_fg().
All other style values are left untouched (se also modify_style()).

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

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

Parameters:
state The state for which to set the background color.
color The color to assign (does not need to be allocated), or null to undo the effect of previous calls to modify_bg().
All other style values are left untouched (see also modify_style()).

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

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

Parameters:
state The state for which to set the text color.
color The color to assign (does not need to be allocated), or null to undo the effect of previous calls to modify_text().
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 Entry and TextView. See also modify_style().

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

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

Parameters:
state The state for which to set the base color.
color The color to assign (does not need to be allocated), or null to undo the effect of previous calls to of modify_base().
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 Entry and TextView. See also modify_style().

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

Sets the font to use for the widget.

Parameters:
font_desc The font description to use, or null to undo the effect of previous calls to modify_font().
All other style values are left untouched. See also modify_style().

Pointer<Pango::Context> Xfc::Gtk::Widget::create_pango_context (  ) 

Creates a new Pango::Context with the appropriate colormap, font description, and base direction for drawing text for this widget (see also get_pango_context()).

Returns:
A smart pointer to the new Pango::Context.

Pointer<Pango::Layout> Xfc::Gtk::Widget::create_pango_layout ( const String text  ) 

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

Parameters:
text The text to set on the layout (can be a null String).
Returns:
A smart pointer to the new Pango::Layout.
If you keep a Pango::Layout created in this way around, in order to notify the layout of changes to the base direction or font for this widget, you must call Pango::Layout::context_changed() in response to the style_set and direction_set signals for the widget.

Pointer<Gdk::Pixbuf> Xfc::Gtk::Widget::render_icon ( const StockId stock_id,
IconSize  size,
const char *  detail = 0 
)

A convenience method that uses the theme engine and RC file settings for the widget to look up stock_id and render it to a pixbuf.

Parameters:
stock_id A stock ID.
size A stock size.
detail The render detail to pass to a theme engine.
Returns:
A smart pointer to the new pixbuf, or null if the stock ID wasn't known.
stock_id should be a stock icon ID such as Gtk::StockId::OPEN or Gtk::StockId::OK. size should be a size such as Gtk::ICON_SIZE_MENU. detail should be a string that identifies the widget or code doing the rendering, so that theme engines can special-case rendering for that widget or code. The pixels in the returned Gdk::Pixbuf are shared with the rest of the application and should not be modified.

void Xfc::Gtk::Widget::set_composite_name ( const String name  ) 

Sets a widgets composite name.

Parameters:
name The name to set.
The widget must be a composite child of its parent (see push_composite_child()).

void Xfc::Gtk::Widget::reset_rc_styles (  ) 

Reset the styles of the widget and all descendents, so when they are looked up again, they get the correct values for the currently loaded RC file settings.

This method is not useful for applications

void Xfc::Gtk::Widget::set_direction ( TextDirection  dir  ) 

Sets the reading direction on a particular widget.

Parameters:
dir The new direction.
This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitely visual rather than logical (such as buttons for text justification). If the direction is set to Gtk::TEXT_DIR_NONE, then the value set by set_default_direction() will be used.

void Xfc::Gtk::Widget::shape_combine_mask ( const Gdk::Bitmap shape_mask,
int  offset_x,
int  offset_y 
)

Sets a shape for this widget's GDK window.

Parameters:
shape_mask The shape to be added.
offset_x The X position of shape mask with respect to window.
offset_y The Y position of shape mask with respect to window.
This allows for transparent windows etc., see Gdk::Window::shape_combine_mask() for more information.

bool Xfc::Gtk::Widget::list_mnemonic_labels ( std::vector< Widget * > &  widgets  ) 

Returns a 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()).

Parameters:
widgets A reference to a vector of Widget* to hold the list of mnemonic labels.
Returns:
true if the vector is not empty.
The widgets in the vector are not individually referenced. If you want to iterate through the vector and perform actions that might destroy the widgets, you must call ref() to reference a widget and unref() to unreference it afterwards.

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

Adds a widget to the list of mnemonic labels for this widget (see Gtk::Widget::list_mnemonic_labels()).

Parameters:
label A Widget that acts as a mnemonic label for this widget.
Note: The list of mnemonic labels for the widget is cleared when the widget is destroyed, so the caller must make sure to update it's internal state at this point as well, by using a connection to the Gtk::Object::signal_destroy() signal.

void Xfc::Gtk::Widget::remove_mnemonic_label ( Widget label  ) 

Removes a widget from the list of mnemonic labels for this widget (see Gtk::Widget::list_mnemonic_labels()).

Parameters:
label Widget that was previously set as a mnemonic label for this widget.
The widget label must have previously been added to the list with add_mnemonic_label().

static void Xfc::Gtk::Widget::push_colormap ( Gdk::Colormap cmap  )  [static]

Pushes cmap onto a global stack of colormaps; the topmost colormap on the stack will be used to create all widgets.

Parameters:
cmap A Gdk::Colormap
Remove cmap with pop_colormap(). There's little reason to use this method.

static void Xfc::Gtk::Widget::push_composite_child (  )  [static]

A composite child is a child that's an implementation detail of the container it's inside and should not be visible to people using the container.

Composite children aren't treated differently by GTK but e.g. GUI builders might want to treat them in a different way.

static void Xfc::Gtk::Widget::set_default_colormap ( Gdk::Colormap colormap  )  [static]

Sets the default colormap to use when creating widgets.

Parameters:
colormap A Gdk::Colormap.
push_colormap() is a better method to use if you only want to affect a few widgets, rather than all widgets.

static void Xfc::Gtk::Widget::set_default_direction ( TextDirection  dir  )  [static]

Sets the default reading direction for widgets where the direction has not been explicitly set by set_direction().

Parameters:
dir The new default direction. This cannot be Gtk::TEXT_DIR_NONE.

Gdk::GrabStatus Xfc::Gtk::Widget::keyboard_grab ( bool  owner_events = false,
unsigned int  time = GDK_CURRENT_TIME 
)

Grabs the keyboard so that all events are passed to this widget until the keyboard is ungrabbed with Gdk::keyboard_ungrab().

Parameters:
owner_events If false then all keyboard events are reported with respect the widget. If true then keyboard events for this application are reported as normal, but keyboard events outside this application are reported with respect to the widget. Both key press and key release events are always reported, independant of the event mask set by the application.
time A timestamp from a Gdk::Event, or GDK_CURRENT_TIME if no timestamp is available.
Returns:
Gdk::GRAB_SUCCESS if the grab was successful.
This overrides any previous keyboard grab by this client. The widget's Gdk::Window will own the grab (the grab window).

Gdk::GrabStatus Xfc::Gtk::Widget::pointer_grab ( Gdk::EventMaskField  event_mask,
Widget confine_to = 0,
Gdk::Cursor cursor = 0,
bool  owner_events = false,
unsigned int  time = GDK_CURRENT_TIME 
)

Grabs the pointer (usually a mouse) so that all events are passed to this widget until the pointer is ungrabbed with Gdk::pointer_ungrab(), or the grab widget becomes unviewable.

Parameters:
event_mask Specifies the event mask, which is used in accordance with owner_events.
confine_to If non-null, the pointer will be confined to this widget during the grab. If the pointer is outside confine_to, it will automatically be moved to the closest edge of confine_to and enter and leave events will be generated as necessary.
cursor The cursor to display while the grab is active. If this is null then the normal cursors are used for the widget and its descendants, and the cursor for the widget is used for all other windows.
owner_events If false then all pointer events are reported with respect to the widget and are only reported if selected by event_mask. If true then pointer events for this application are reported as normal, but pointer events outside this application are reported with respect to the widget and only if selected by event_mask. In either mode, unreported events are discarded.
time The timestamp of the event which led to this pointer grab. This usually comes from a Gdk::EventButton, though GDK_CURRENT_TIME can be used if the time isn't known.
Returns:
Gdk::GRAB_SUCCESS if the grab was successful.
This overrides any previous pointer grab by this client. The widget's Gdk::Window will own the grab (the grab window). Pointer grabs are used for operations which need complete control over mouse events, even if the mouse leaves the application. For example in GTK+ it is used for Drag and Drop, for dragging the handle in the HPaned and VPaned widgets. Note that if the event mask of an X window has selected both button press and button release events, then a button press event will cause an automatic pointer grab until the button is released. X does this automatically since most applications expect to receive button press and release events in pairs. It is equivalent to a pointer grab on the window with owner_events set to true.

bool Xfc::Gtk::Widget::selection_owner_get ( Gdk::Atom  selection  ) 

Returns whether the widget owns selection.

Parameters:
selection An interned atom representing the selection to check.
Returns:
true if this widget owns selection.

bool Xfc::Gtk::Widget::selection_owner_set ( Gdk::Atom  selection,
unsigned int  time,
const Gdk::Display display = 0 
)

Claim ownership of a given selection for a particular widget.

Parameters:
selection An interned atom representing the selection to claim.
time A timestamp with which to claim the selection, or GDK_CURRENT_TIME.
display The Gdk::Display where the selection is set, or null for the default display.
Returns:
true if the operation succeeded.

void Xfc::Gtk::Widget::selection_add_target ( Gdk::Atom  selection,
Gdk::Atom  target,
unsigned int  info 
)

Adds the specified target to the list of supported targets for the widget and selection.

Parameters:
selection The selection.
target The target to add.
info An unsigned integer which will be passed back to the application.

void Xfc::Gtk::Widget::selection_add_target ( Gdk::Atom  selection,
const TargetEntry entry 
)

Adds the specified target to the list of supported targets for the widget and selection.

Parameters:
selection The selection.
entry The target entry to add.

void Xfc::Gtk::Widget::selection_add_targets ( Gdk::Atom  selection,
const std::vector< TargetEntry > &  targets 
)

Adds the targets specified in targets to the list of supported targets for the widget and selection.

Parameters:
selection The selection.
targets A reference to a vector of TargetEntry that holds the targets to add.

void Xfc::Gtk::Widget::selection_clear_targets ( Gdk::Atom  selection  ) 

Remove all targets registered for the given selection for the widget.

Parameters:
selection An atom representing a selection.

bool Xfc::Gtk::Widget::selection_convert ( Gdk::Atom  selection,
Gdk::Atom  target,
unsigned int  time = GDK_CURRENT_TIME 
)

Requests the contents of a selection.

Parameters:
selection Which selection to get.
target Form of information desired (e.g., STRING).
time Time of request (usually of triggering event), or you could use GDK_CURRENT_TIME.
Returns:
true if the request succeeded. false if we could not process the request (e.g. there was already a request in process for this widget).
When received, a selection_received signal will be generated.

void Xfc::Gtk::Widget::selection_remove_all (  ) 

Removes all handlers and unsets ownership of all selections for the widget.

Called when the widget is being destroyed. This method will not generally be called by applications.

static bool Xfc::Gtk::Widget::selection_owner_unset ( Gdk::Atom  selection,
unsigned int  time,
const Gdk::Display display = 0 
) [static]

Releases ownership of a given selection.

Parameters:
selection An interned atom representing the selection to release.
time A timestamp with which to claim the selection, or GDK_CURRENT_TIME.
display The Gdk::Display where the selection is set, or null for the default display.
Returns:
true if the operation succeeded.

void Xfc::Gtk::Widget::drag_get_data ( DragContext context,
Gdk::Atom  target,
unsigned int  time = GDK_CURRENT_TIME 
)

Gets the data associated with a drag.

Parameters:
context The drag context.
target The target (form of the data) to retrieve.
time A timestamp for retrieving the data.
When the data is received or the retrieval fails, GTK+ will emit a drag_data_received signal. Failure of the retrieval is indicated by Gtk::SelectionData::is_valid() returning false. However, when drag_get_data() is called implicitely because the Gtk::DRAG_DEFAULT_DROP was set, then the widget will not receive notification of failed drops and Gtk::SelectionData::is_valid() will be undefined. time will generally be the time received in a drag_data_motion or drag_data_drop signal.

void Xfc::Gtk::Widget::drag_highlight (  ) 

Draws a highlight around the widget.

This will attach handlers to expose_event and draw, so the highlight will continue to be displayed until drag_unhighlight() is called.

void Xfc::Gtk::Widget::drag_dest_set ( DestDefaultsField  flags,
const TargetEntry target,
Gdk::DragActionField  actions 
)

Sets the widget as a potential drop destination.

Parameters:
flags The flags that specify what actions GTK+ should take on behalf of a widget for drops onto that widget.
target A TargetEntry indicating the drop type that this widget will accept.
actions A bitmask of possible actions for a drop onto this widget.
The targets and actions fields only are used if DEST_DEFAULT_MOTION or DEST_DEFAULT_DROP are given.

void Xfc::Gtk::Widget::drag_dest_set ( DestDefaultsField  flags,
const std::vector< TargetEntry > &  targets,
Gdk::DragActionField  actions 
)

Sets the widget as a potential drop destination.

Parameters:
flags The flags that specify what actions GTK+ should take on behalf of a widget for drops onto that widget.
targets A vector of TargetEntry indicating the drop types that this widget will accept.
actions A bitmask of possible actions for a drop onto this widget.
The targets and actions fields only are used if DEST_DEFAULT_MOTION or DEST_DEFAULT_DROP are given.

void Xfc::Gtk::Widget::drag_dest_set_proxy ( Gdk::Window proxy_window,
Gdk::DragProtocol  protocol,
bool  use_coordinates 
)

Sets the widget as a proxy for drops to another window.

Parameters:
proxy_window The window to which to forward drag events
protocol The drag protocol which the proxy_window accepts (You can use gdk_drag_get_protocol() to determine this).
use_coordinates If true, send the same coordinates to the destination, because it is an embedded subwindow.

void Xfc::Gtk::Widget::drag_dest_unset (  ) 

Clears information about a drop destination set with drag_dest_set().

The widget will no longer receive notification of drags.

Gdk::Atom Xfc::Gtk::Widget::drag_dest_find_target ( const DragContext context,
const TargetList target_list = 0 
)

Looks for a match between context.targets() and the target_list, returning the first matching target, otherwise returning GDK_NONE.

Parameters:
context A drag context.
target_list A TargetList of droppable targets, or null to use drag_dest_get_target_list().
Returns:
The first target that the source offers and the dest can accept, or GDK_NONE.
The target_list should usually be the return value from drag_dest_get_target_list(), but some widgets may have different valid targets for different parts of the widget; in that case, they will have to implement a drag_motion handler that passes the correct target list to this function.

TargetList* Xfc::Gtk::Widget::drag_dest_get_target_list (  )  const

Returns the list of targets this widget can accept from drag-and-drop.

Returns:
The TargetList, or null if none.

void Xfc::Gtk::Widget::drag_dest_set_target_list ( TargetList target_list  ) 

Sets the target types that this widget can accept from drag-and-drop.

Parameters:
target_list A list of droppable targets, or null for none.
The widget must first be made into a drag destination with drag_dest_set().

void Xfc::Gtk::Widget::drag_dest_add_text_targets (  ) 

Add the text targets supported by Gtk::Selection to the target list of the drag destination.

The targets are added with info = 0. If you need another value, use Gtk::TargetList::add_text_targets() and drag_dest_set_target_list().

void Xfc::Gtk::Widget::drag_dest_add_image_targets (  ) 

Add the image targets supported by Gtk::Selection to the target list of the drag destination.

The targets are added with info = 0. If you need another value, use Gtk::TargetList::add_image_targets() and drag_dest_set_target_list().

void Xfc::Gtk::Widget::drag_dest_add_uri_targets (  ) 

Add the URI targets supported by Gtk::Selection to the target list of the drag destination.

The targets are added with info = 0. If you need another value, use Gtk::TargetList::add_uri_targets() and drag_dest_set_target_list().

DragContext* Xfc::Gtk::Widget::drag_source_begin ( const TargetList targets,
Gdk::DragActionField  actions,
int  button,
const Gdk::Event event 
)

Initiates a drag on the source side.

Parameters:
targets The targets (data formats) in which the source can provide the data.
actions A bitmask of the allowed drag actions for this drag.
button The button the user clicked to start the drag.
event The event that triggered the start of the drag.
Returns:
The context for this drag.
The method only needs to be used when the application is starting drags itself, and is not needed when drag_source_set() is used.

void Xfc::Gtk::Widget::drag_source_set ( Gdk::ModifierTypeField  start_button_mask,
const TargetEntry target,
Gdk::DragActionField  actions 
)

Sets up the widget so that GTK+ will start a drag operation when the user clicks and drags on the widget.

Parameters:
start_button_mask The bitmask of buttons that can start the drag.
target The TargetEntry for the target the drag will support.
actions The bitmask of possible actions for a drag from this widget.

void Xfc::Gtk::Widget::drag_source_set ( Gdk::ModifierTypeField  start_button_mask,
const std::vector< TargetEntry > &  targets,
Gdk::DragActionField  actions 
)

Sets up the widget so that GTK+ will start a drag operation when the user clicks and drags on the widget.

Parameters:
start_button_mask The bitmask of buttons that can start the drag.
targets A vector of TargetEntry for the targets the drag will support.
actions The bitmask of possible actions for a drag from this widget.

TargetList* Xfc::Gtk::Widget::drag_source_get_target_list (  )  const

Gets the list of targets this widget can provide for drag-and-drop.

Returns:
The TargetList, or null for none.

void Xfc::Gtk::Widget::drag_source_set_target_list ( TargetList target_list  ) 

Changes the target types that this widget offers for drag-and-drop.

Parameters:
target_list The list of draggable targets, or null for none .
The widget must first be made into a drag source with drag_source_set().

void Xfc::Gtk::Widget::drag_source_add_text_targets (  ) 

Add the text targets supported by Gtk::Selection to the target list of the drag source.

The targets are added with info = 0. If you need another value, use Gtk::TargetList::add_text_targets() and drag_source_set_target_list().

void Xfc::Gtk::Widget::drag_source_add_image_targets (  ) 

Add the image targets supported by Gtk::Selection to the target list of the drag source.

The targets are added with info = 0. If you need another value, use Gtk::TargetList::add_image_targets() and drag_source_set_target_list().

void Xfc::Gtk::Widget::drag_source_add_uri_targets (  ) 

Add the URI targets supported by Gtk::Selection to the target list of the drag source.

The targets are added with info = 0. If you need another value, use Gtk::TargetList::add_uri_targets() and drag_source_set_target_list().

void Xfc::Gtk::Widget::drag_source_set_icon ( Gdk::Colormap colormap,
Gdk::Pixmap pixmap,
Gdk::Bitmap mask 
)

Sets the icon that will be used for drags from the widget from a pixmap and mask.

Parameters:
colormap The colormap of the icon.
pixmap The image data for the icon.
mask The transparency mask for an image.
GTK+ retains references for the arguments, and will release them when they are no longer needed. Use drag_source_set_icon_pixbuf() instead.

void Xfc::Gtk::Widget::drag_source_set_icon_pixbuf ( Gdk::Pixbuf pixbuf  ) 

Sets the icon that will be used for drags from the widget from a Gdk::Pixbuf.

Parameters:
pixbuf The Gdk::Pixbuf for the drag icon.
GTK+ retains references for pixbuf, and will release it when it is no longer needed.

void Xfc::Gtk::Widget::drag_source_set_icon_stock ( const StockId stock_id  ) 

Sets the icon that will be used for drags from the widget to a stock icon.

Parameters:
stock_id The stock ID of the icon to use.

bool Xfc::Gtk::Widget::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 threshhold, and thus should trigger the beginning of a drag-and-drop operation.

Parameters:
start_x The X coordinate of start of drag.
start_y The Y coordinate of start of drag.
current_x The current X coordinate.
current_y The current Y coordinate.
Returns:
true if the drag threshold has been passed.

const HierarchyChangedSignalProxy Xfc::Gtk::Widget::signal_hierarchy_changed (  ) 

Connect to the hierarchy_changed_signal; emitted when there is a change in the hierarchy to which the widget belongs.

More precisely, when its toplevel ancestor changes.

const ChildNotifySignalProxy Xfc::Gtk::Widget::signal_child_notify ( const String property_name  ) 

Connect to the child_notify_signal; emitted for each child property that changes on a widget.

Parameters:
property_name The property name to be notified of changes to.
If property_name is provided it is appended to the signal name so that the signal connected to becomes "child_notify::property_name". What this does is ensure that your child notification slot is only called if property_name matches the property name of the "child_notify" signal being emitted.

const AccelClosuresChangedSignalProxy Xfc::Gtk::Widget::signal_accel_closures_changed (  ) 

Connect to the accel_closures_changed_signal; emitted whenever the closures used by the widget for accelerator group connections are changed.

The closures can be used to monitor accelerator changes on widget.

const DragBeginSignalProxy Xfc::Gtk::Widget::signal_drag_begin (  ) 

Connect to the drag_begin_signal; emitted on the drag source when a drag is started.

A typical reason to connect to this signal is to set up a custom drag icon with drag_source_set_icon().

const DragEndSignalProxy Xfc::Gtk::Widget::signal_drag_end (  ) 

Connect to the drag_end_signal; emitted on the drag source when a drag is finished.

A typical reason to connect to this signal is to undo things done in drag_begin.

const DragDataGetSignalProxy Xfc::Gtk::Widget::signal_drag_data_get (  ) 

Connect to the drag_data_get_signal; emitted on the drag source when the drop site requests the data of the first target supported.

It is the responsibility of the signal handler to fill Gtk::SelectionData with the data in the format which is indicated by info (third) argument (see Gtk::SelectionData::set() and Gtk::SelectionData::set_text()).

const DragDataDeleteSignalProxy Xfc::Gtk::Widget::signal_drag_data_delete (  ) 

Connect to the drag_data_delete_signal; emitted on the drag source when a drag with the action Gdk::ACTION_MOVE is successfully completed.

It indicates that the data can be deleted.

const DragLeaveSignalProxy Xfc::Gtk::Widget::signal_drag_leave (  ) 

Connect to the drag_leave_signal; emitted on the drop site when the cursor leaves the widget.

A typical reason to connect to this signal is to undo things done in drag_motion, e.g. undo highlighting with drag_unhighlight().

const DragMotionSignalProxy Xfc::Gtk::Widget::signal_drag_motion (  ) 

Connect to the drag_motion_signal; emitted on the drop site when the user moves the cursor over the widget during a drag.

The signal handler must determine whether the cursor position is in a drop zone or not. If it is not in a drop zone, it returns 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 Gdk::DragContext::drag_status(). 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 drag_get_data() and defer the Gdk::DragContext::drag_status() call to the drag_data_received signal 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 drag_highlight().

const DragDropSignalProxy Xfc::Gtk::Widget::signal_drag_drop (  ) 

Connect to the drag_drop_signal; emitted on the drop site when the user drops the data onto the widget.

The signal handler must determine whether the cursor position is in a drop zone or not. If it is not in a drop zone, it returns false and no further processing is necessary. Otherwise, the handler returns true. In this case, the handler must ensure that Gtk::DragContext::finish() is called to let the source know that the drop is done. The call to Gtk::DragContext::finish() can be done either directly or in a drag_data_received handler which gets triggered by calling drag_get_data() to receive the data for one or more of the supported targets.

const DragDataReceivedSignalProxy Xfc::Gtk::Widget::signal_drag_data_received (  ) 

Connect to the drag_data_received_signal; emitted on the drop site when the dragged data has been received.

If the data was received in order to determine whether the drop will be accepted, the handler is expected to call Gdk::DragContext::drag_status() 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 Gtk::DragContext::finish(), setting the success parameter depending on whether the data was processed successfully.

The handler may inspect and modify the drag action chosen by the drop site by calling Gdk::DragContext()action() and Gdk::DragContext()set_action() before calling Gtk::DragContext::finish().

const EventAfterSignalProxy Xfc::Gtk::Widget::signal_event_after (  ) 

Connect to the event_after_signal; emitted after any GDK event occurs.

This signal is used to observe events but not act on them. Hence the void return value. This signal exists because slots connected to events as 'after' handlers get called after the default handler, but if the signal was handled they wont get called. Connect to this signal if you just want to monitor GDK events.


Member Data Documentation

const ShowSignalType Xfc::Gtk::Widget::show_signal [static, protected]

Show signal (see signal_show()).

Calls a slot with the signature:

< void function();
<

const HideSignalType Xfc::Gtk::Widget::hide_signal [static, protected]

Hide signal (see signal_hide()).

Calls a slot with the signature:

< void function();
<

const MapSignalType Xfc::Gtk::Widget::map_signal [static, protected]

Map signal (see signal_Map()).

Calls a slot with the signature:

< void function();
<

const UnmapSignalType Xfc::Gtk::Widget::unmap_signal [static, protected]

Unmap signal (see signal_unmap()).

Calls a slot with the signature:

< void function();
<

const RealizeSignalType Xfc::Gtk::Widget::realize_signal [static, protected]

Realize signal (see signal_realize()).

Calls a slot with the signature:

< void function();
<

const UnrealizeSignalType Xfc::Gtk::Widget::unrealize_signal [static, protected]

Unrealize signal (see signal_unrealize()).

Calls a slot with the signature:

< void function();
<

const SizeRequestSignalType Xfc::Gtk::Widget::size_request_signal [static, protected]

Size request signal (see signal_size_request()).

Calls a slot with the signature:

< void function(Requisition *requisition);
< // requisition: The Requisition to be filled in.
<

const SizeAllocateSignalType Xfc::Gtk::Widget::size_allocate_signal [static, protected]

Size allocate signal (see signal_size_allocate()).

Calls a slot with the signature:

< void function(const Allocation& allocation);
< // allocation: The position and size allocated to the widget.
<

const StateChangedSignalType Xfc::Gtk::Widget::state_changed_signal [static, protected]

State changed signal (see signal_state_changed()).

Calls a slot with the signature:

< void function(StateType previous_state);
< // previous_state: The previous StateType.
<

const ParentSetSignalType Xfc::Gtk::Widget::parent_set_signal [static, protected]

Parent set signal (see signal_parent_set()).

Calls a slot with the signature:

< void function((Widget *previous_parent);
< // previous_parent: The previous parent of the widget, or null.
<

const HierarchyChangedSignalType Xfc::Gtk::Widget::hierarchy_changed_signal [static, protected]

Hierarchy changed signal (see signal_hierarchy_changed()).

Calls a slot with the signature:

< void function(Widget *previous_toplevel);
< // previous_toplevel: The previous toplevel widget.
<

const StyleSetSignalType Xfc::Gtk::Widget::style_set_signal [static, protected]

Style set signal (see signal_style_set()).

Calls a slot with the signature:

< void function(Style* previous_style);
< // previous_style: The previous Style, or null.
<

const DirectionChangedSignalType Xfc::Gtk::Widget::direction_changed_signal [static, protected]

Direction changed signal (see signal_direction_changed()).

Calls a slot with the signature:

< void function(TextDirection  previous_direction);
< // previous_direction: The previous direction.
<

const GrabNotifySignalType Xfc::Gtk::Widget::grab_notify_signal [static, protected]

Grab notify signal (see signal_grab_notify()).

Calls a slot with the signature:

< void function(bool was_grabbed);
< // was_grabbed: true if the widget is the current grabbed widget, false
< //              if it was but is no longer the current grabbed widget.
<

const ChildNotifySignalType Xfc::Gtk::Widget::child_notify_signal [static, protected]

Child notify signal (see signal_child_notify()).

Calls a slot with the signature:

< void function(GParamSpec *pspec);
< // pspec: A GParamSpec object that holds the meta data specifying the new property.
<

const MnemonicActivateSignalType Xfc::Gtk::Widget::mnemonic_activate_signal [static, protected]

Mnemonic activate signal (see signal_mnemonic_activate()).

Calls a slot with the signature:

< bool function(bool group_cycling);
< // group_cycling:
<

const GrabFocusSignalType Xfc::Gtk::Widget::grab_focus_signal [static, protected]

Grab focus signal (see signal_grab_focus()).

Calls a slot with the signature:

< void function();
<

const FocusSignalType Xfc::Gtk::Widget::focus_signal [static, protected]

Focus signal (see signal_focus()).

Calls a slot with the signature:

< bool function(DirectionType direction);
< // direction: The direction of focus movement.
< // return: true if the focus ended up inside the child widget.
<

const AccelClosuresChangedSignalType Xfc::Gtk::Widget::accel_closures_changed_signal [static, protected]

Accel closures changed signal (see signal_accel_closures_changed()).

Calls a slot with the signature:

< void function();
<

const ScreenChangedSignalType Xfc::Gtk::Widget::screen_changed_signal [static, protected]

Screen changed signal (see signal_screen_changed()).

Calls a slot with the signature:

< void function(Gdk::Screen *previous_screen);
< // previous_screen: The previous Gdk:Screen.
<

const CanActivateAccelSignalType Xfc::Gtk::Widget::can_activate_accel_signal [static, protected]

Can activate accel signal (see signal_can_activate_accel()).

Calls a slot with the signature:

< bool function(unsigned int signal_id);
< // signal_id: The id of a signal installed on the widget.
< // return: true if the accelerator can be activated.
<

const SelectionGetSignalType Xfc::Gtk::Widget::selection_get_signal [static, protected]

Selection get signal (see signal_selection_get()).

Calls a slot with the signature:

< void function(SelectionData& selection_data, unsigned int info, unsigned int time);
< // selection_data: The SelectionData object to be filled in.
< // info: The info integer that was set when the target was registered (see TargetEntry).
< // time: The time of the conversion request as set by the requestor with selectionn_convert().
<

const SelectionReceivedSignalType Xfc::Gtk::Widget::selection_received_signal [static, protected]

Selection received signal (see signal_selection_received()).

Calls a slot with the signature:

< void function(const SelectionData& selection_data, unsigned int time);
< // selection_data: The requested selection data.
< // time: The time of the conversion request.
<

const DragBeginSignalType Xfc::Gtk::Widget::drag_begin_signal [static, protected]

Drag begin signal (see signal_drag_begin()).

Calls a slot with the signature:

< void function(DragContext& context);
< // context: A reference to a Gtk::DragContext (only used by GTK+).
<

const DragEndSignalType Xfc::Gtk::Widget::drag_end_signal [static, protected]

Drag end signal (see signal_drag_end()).

Calls a slot with the signature:

< void function(DragContext& context);
< // context: A reference to a Gtk::DragContext (only used by GTK+).
<

const DragDataGetSignalType Xfc::Gtk::Widget::drag_data_get_signal [static, protected]

Drag data get signal (see signal_drag_data_get()).

Calls a slot with the signature:

< void function(DragContext& context, SelectionData& data, unsigned int info, unsigned int time);
< // context: A reference to a Gtk::DragContext (only used by GTK+).
< // data: The SelectionData that needs to be filled in to provide the requested data.
< // info: The info integer that was set when the target was registered (see TargertEntry).
< // time: The time of the conversion request.
<

const DragDataDeleteSignalType Xfc::Gtk::Widget::drag_data_delete_signal [static, protected]

Drag data delete signal (see signal_drag_data_delete()).

Calls a slot with the signature:

< void function(DragContext& context);
< // context: A reference to a Gtk::DragContext (only used by GTK+).
<

const DragLeaveSignalType Xfc::Gtk::Widget::drag_leave_signal [static, protected]

Drag leave signal (see signal_drag_leave()).

Calls a slot with the signature:

< void function(DragContext& context, unsigned int time);
< // context: A reference to the Gtk::DragContext for the current drag-and-drop event.
< // time: The timestamp of the motion event.
<

const DragMotionSignalType Xfc::Gtk::Widget::drag_motion_signal [static, protected]

Drag motion signal (see signal_drag_motion()).

Calls a slot with the signature:

< bool function(DragContext& context, int x, int y, unsigned int time);
< // context: A reference to the Gtk::DragContext for the current drag-and-drop event.
< // x: The X position of the mouse pointer relative to the widget.
< // y: The Y position of the mouse pointer relative to the widget.
< // time: The time when the event occurred.
< // return: true if the widget is a valid drag-and-drop destination.
<

const DragDropSignalType Xfc::Gtk::Widget::drag_drop_signal [static, protected]

Drag drop signal (see signal_drag_drop()).

Calls a slot with the signature:

< bool function(DragContext& context, int x, int y, unsigned int time);
< // context: A reference to the Gtk::DragContext for the current drag-and-drop event.
< // x: The X position of the mouse pointer relative to the widget.
< // y: The Y position of the mouse pointer relative to the widget.
< // time: The time when the event occurred.
< // return: true if the widget is a valid drag-and-drop destination.
<

const DragDataReceivedSignalType Xfc::Gtk::Widget::drag_data_received_signal [static, protected]

Drag data received signal (see signal_drag_data_received()).

Calls a slot with the signature:

< void function(DragContext& context, int x, int y, const SelectionData& data, unsigned int info, unsigned int time);
< // context: A reference to a Gtk::DragContext.
< // x: The X position of the mouse pointer relative to the widget. 
< // y: The Y position of the mouse pointer relative to the widget. 
< // data: The SelectionData that contains all the information about the data received.
< // info: The info integer that was set when the target was registered (see TargertEntry).
< // time: The time of the conversion request.
<

const EventSignalType Xfc::Gtk::Widget::event_signal [static, protected]

Event signal (see signal_event()).

Calls a slot with the signature:

< bool function(const Gdk::Event& event);
< // event: The Gdk::Event.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const EventAfterSignalType Xfc::Gtk::Widget::event_after_signal [static, protected]

Event after signal (see signal_event_after()).

Calls a slot with the signature:

< void function(const Gdk::Event& event);
< // event: The Gdk::Event.
<

const ButtonPressEventSignalType Xfc::Gtk::Widget::button_press_event_signal [static, protected]

Button press event signal (see signal_button_press_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventButton& event);
< // event: The Gdk::EventButton.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const ButtonReleaseEventSignalType Xfc::Gtk::Widget::button_release_event_signal [static, protected]

Button release event signal (see signal_button_release_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventButton& event);
< // event: The Gdk::EventButton.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const ScrollEventSignalType Xfc::Gtk::Widget::scroll_event_signal [static, protected]

Scroll event signal (see signal_scroll_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventScroll& event);
< // event: The Gdk::EventScroll.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const MotionNotifyEventSignalType Xfc::Gtk::Widget::motion_notify_event_signal [static, protected]

Motion notify event signal (see signal_motion_notify_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventMotion& event);
< // event: The Gdk::EventMotion.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const DeleteEventSignalType Xfc::Gtk::Widget::delete_event_signal [static, protected]

Delete event signal (see signal_delete_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventAny& event);
< // event: The Gdk::Event.
< // return: false to allow the application window to close.
<

const DestroyEventSignalType Xfc::Gtk::Widget::destroy_event_signal [static, protected]

Destroy event signal (see signal_destroy_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventAny& event);
< // event: The Gdk::EventAny.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const ExposeEventSignalType Xfc::Gtk::Widget::expose_event_signal [static, protected]

Expose event signal (see signal_expose_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventExpose& event);
< // event: The Gdk::EventExpose.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const KeyPressEventSignalType Xfc::Gtk::Widget::key_press_event_signal [static, protected]

Key press event signal (see signal_key_press_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventKey& event);
< // event: The Gdk::EventKey.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const KeyReleaseEventSignalType Xfc::Gtk::Widget::key_release_event_signal [static, protected]

Key release event signal (see signal_key_release_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventKey& event);
< // event: The Gdk::EventKey.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const EnterNotifyEventSignalType Xfc::Gtk::Widget::enter_notify_event_signal [static, protected]

Enter notify event signal (see signal_enter_notify_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventCrossing& event);
<

const LeaveNotifyEventSignalType Xfc::Gtk::Widget::leave_notify_event_signal [static, protected]

Leave notify event signal (see signal_leave_notify_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventCrossing& event);
< // event: The Gdk::EventCrossing.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const ConfigureEventSignalType Xfc::Gtk::Widget::configure_event_signal [static, protected]

Configure event signal (see signal_configure_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventConfigure& event);
< // event: The Gdk::EventConfigure.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const FocusInEventSignalType Xfc::Gtk::Widget::focus_in_event_signal [static, protected]

Focus in event signal (see signal_focus_in_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventFocus& event);
< // event: The Gdk::EventFocus.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const FocusOutEventSignalType Xfc::Gtk::Widget::focus_out_event_signal [static, protected]

Focus out event signal (see signal_focus_out_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventFocus& event);
< // event: The Gdk::EventFocus.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const MapEventSignalType Xfc::Gtk::Widget::map_event_signal [static, protected]

Map event signal (see signal_map_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventAny& event);
< // event: The Gdk::EventAny.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const UnmapEventSignalType Xfc::Gtk::Widget::unmap_event_signal [static, protected]

Unmap event signal (see signal_unmap_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventAny& event);
< // event: The Gdk::EventAny.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const PropertyNotifyEventSignalType Xfc::Gtk::Widget::property_notify_event_signal [static, protected]

Property notify event signal (see signal_property_notify_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventProperty& event);
< // event: The Gdk::EventProperty.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const SelectionClearEventSignalType Xfc::Gtk::Widget::selection_clear_event_signal [static, protected]

Selection clear event signal (see signal_selection_clear_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventSelection& event);
< // event: The Gdk::EventSelection.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const SelectionRequestEventSignalType Xfc::Gtk::Widget::selection_request_event_signal [static, protected]

Selection request event signal (see signal_selection_request_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventSelection& event);
< // event: The Gdk::EventSelection.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const SelectionNotifyEventSignalType Xfc::Gtk::Widget::selection_notify_event_signal [static, protected]

Selection notify event signal (see signal_selection_notify_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventSelection& event);
< // event: The Gdk::EventSelection.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const ProximityInEventSignalType Xfc::Gtk::Widget::proximity_in_event_signal [static, protected]

Proximity in event signal (see signal_proximity_in_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventProximity& event);
< // event: The Gdk::EventProximity.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const ProximityOutEventSignalType Xfc::Gtk::Widget::proximity_out_event_signal [static, protected]

Proximity out event signal (see signal_proximity_out_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventProximity& event);
< // event: The Gdk::EventProximity.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const VisibilityNotifyEventSignalType Xfc::Gtk::Widget::visibility_notify_event_signal [static, protected]

Visibility notify event signal (see signal_visibility_notify_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventVisibility& event);
< // event: The Gdk::EventVisibility.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const ClientEventSignalType Xfc::Gtk::Widget::client_event_signal [static, protected]

Client event signal (see signal_client_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventClient& event);
< // event: The Gdk::EventClient.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const NoExposeEventSignalType Xfc::Gtk::Widget::no_expose_event_signal [static, protected]

No expose event signal (see signal_no_expose_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventAny& event);
< // event: The Gdk::EventAny.
< // return: true to stop invoking other handlers, false to propagate the event.
<

const WindowStateEventSignalType Xfc::Gtk::Widget::window_state_event_signal [static, protected]

Window state event signal (see signal_window_state_event()).

Calls a slot with the signature:

< bool function(const Gdk::EventWindowState& event);
< // event: The Gdk::EventWindowState.
< // return: true to stop invoking other handlers, false to propagate the event.
<


The documentation for this class was generated from the following file: Xfce Foundation Classes
Copyright © 2004-2005 The XFC Development Team XFC 4.3