Ardour  8.7-14-g57a6773833
Gtk::Socket Class Reference

#include <socket.h>

Inheritance diagram for Gtk::Socket:
[legend]

Public Member Functions

virtual ~Socket ()
 
GtkSocketgobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkSocketgobj () const
 Provides access to the underlying C GtkObject. More...
 
 Socket ()
 
void add_id (Gdk::NativeWindow window_id)
 
Gdk::NativeWindow get_id () const
 
Glib::RefPtr< Gdk::Windowget_plug_window ()
 
Glib::RefPtr< const Gdk::Windowget_plug_window () const
 
Glib::SignalProxy0< void > signal_plug_added ()
 
Glib::SignalProxy0< bool > signal_plug_removed ()
 
- Public Member Functions inherited from Gtk::Container
virtual ~Container ()
 
GtkContainergobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkContainergobj () const
 Provides access to the underlying C GtkObject. More...
 
void set_border_width (guint border_width)
 
guint get_border_width () const
 
virtual void add (Widget &widget)
 
void remove (Widget &widget)
 
void set_resize_mode (ResizeMode resize_mode)
 
ResizeMode get_resize_mode () const
 
void check_resize ()
 
void foreach (const ForeachSlot &slot)
 
Glib::ListHandle< Widget * > get_children ()
 (internal) Operate on contained items (see foreach()) More...
 
Glib::ListHandle< const Widget * > get_children () const
 
void propagate_expose (Widget &child, GdkEventExpose *event)
 
void set_focus_chain (const Glib::ListHandle< Widget * > &focusable_widgets)
 
bool has_focus_chain () const
 
Glib::ListHandle< Widget * > get_focus_chain ()
 
Glib::ListHandle< const Widget * > get_focus_chain () const
 
void unset_focus_chain ()
 
void set_reallocate_redraws (bool needs_redraws=true)
 
void set_focus_child (Widget &widget)
 
void set_focus_vadjustment (Adjustment &adjustment)
 
Adjustmentget_focus_vadjustment ()
 
const Adjustmentget_focus_vadjustment () const
 
void set_focus_hadjustment (Adjustment &adjustment)
 
Adjustmentget_focus_hadjustment ()
 
const Adjustmentget_focus_hadjustment () const
 
void resize_children ()
 
GType child_type () const
 
Glib::SignalProxy1< void, Widget * > signal_add ()
 
Glib::SignalProxy1< void, Widget * > signal_remove ()
 
Glib::SignalProxy0< void > signal_check_resize ()
 
Glib::SignalProxy1< void, Widget * > signal_set_focus_child ()
 
void show_all_children (bool recursive=true)
 
- Public Member Functions inherited from Gtk::Widget
virtual ~Widget ()
 
GtkWidgetgobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkWidgetgobj () const
 Provides access to the underlying C GtkObject. More...
 
bool set_scroll_adjustments (Adjustment &hadjustment, Adjustment &vadjustment)
 
void show ()
 
void show_now ()
 
void hide ()
 
void show_all ()
 
void hide_all ()
 
void queue_draw ()
 
void queue_draw_area (int x, int y, int width, int height)
 
void queue_resize ()
 
Requisition size_request () const
 
void size_request (const Requisition &requisition)
 
void size_allocate (const Allocation &allocation)
 
void add_accelerator (const Glib::ustring &accel_signal, const Glib::RefPtr< AccelGroup > &accel_group, guint accel_key, Gdk::ModifierType accel_mods, AccelFlags accel_flags)
 
bool remove_accelerator (const Glib::RefPtr< AccelGroup > &accel_group, guint accel_key, Gdk::ModifierType accel_mods)
 
void set_accel_path (const Glib::ustring &accel_path, const Glib::RefPtr< AccelGroup > &accel_group)
 
bool mnemonic_activate (bool group_cycling)
 
bool event (GdkEvent *event)
 
int send_expose (GdkEvent *event)
 
bool send_focus_change (GdkEvent *event)
 
bool activate ()
 
void reparent (Widget &new_parent)
 
bool intersect (const Gdk::Rectangle &area) const
 
bool intersect (const Gdk::Rectangle &area, Gdk::Rectangle &intersection) const
 
Gdk::Region region_intersect (const Gdk::Region &region) const
 
void freeze_child_notify ()
 
void child_notify (const Glib::ustring &child_property)
 
void thaw_child_notify ()
 
void set_can_focus (bool can_focus=true)
 
bool get_can_focus () const
 
bool can_focus () const
 
bool has_focus () const
 
bool is_focus () const
 
void grab_focus ()
 
void set_can_default (bool can_default=true)
 
bool get_can_default () const
 
bool can_default () const
 
bool has_default () const
 
void grab_default ()
 
void set_receives_default (bool receives_default=true)
 
bool get_receives_default () const
 
bool has_grab () const
 
void add_modal_grab ()
 
void remove_modal_grab ()
 
void set_name (const Glib::ustring &name)
 
void unset_name ()
 
Glib::ustring get_name () const
 
void set_state (StateType state)
 
StateType get_state () const
 
void set_sensitive (bool sensitive=true)
 
bool get_sensitive () const
 
bool is_sensitive () const
 
void set_visible (bool visible=true)
 
bool get_visible () const
 
void set_has_window (bool has_window=true)
 
bool get_has_window () const
 
bool get_is_toplevel () const
 
bool get_is_drawable () const
 
bool get_realized () const
 
bool get_mapped () const
 
void set_app_paintable (bool app_paintable=true)
 
bool get_app_paintable () const
 
void set_double_buffered (bool double_buffered=true)
 
bool get_double_buffered () const
 
void set_redraw_on_allocate (bool redraw_on_allocate=true)
 
void set_child_visible (bool is_visible=true)
 
bool get_child_visible () const
 
void set_window (const Glib::RefPtr< Gdk::Window > &window)
 
Glib::RefPtr< Gdk::Windowget_window ()
 
Glib::RefPtr< const Gdk::Windowget_window () const
 
Allocation get_allocation () const
 
void set_allocation (const Allocation &allocation)
 
Containerget_parent ()
 
const Containerget_parent () const
 
Glib::RefPtr< Gdk::Windowget_parent_window ()
 
Glib::RefPtr< const Gdk::Windowget_parent_window () const
 
void set_parent_window (const Glib::RefPtr< const Gdk::Window > &parent_window)
 
bool child_focus (DirectionType direction)
 
bool keynav_failed (DirectionType direction)
 
void error_bell ()
 
void set_size_request (int width=-1, int height=-1)
 
void get_size_request (int &width, int &height) const
 
void set_events (Gdk::EventMask events)
 
void add_events (Gdk::EventMask events)
 
void set_extension_events (Gdk::ExtensionMode mode)
 
Gdk::ExtensionMode get_extension_events () const
 
Containerget_toplevel ()
 
const Containerget_toplevel () const
 
Widgetget_ancestor (GType widget_type)
 
const Widgetget_ancestor (GType widget_type) const
 
Glib::RefPtr< Gdk::Colormapget_colormap ()
 
Glib::RefPtr< Gdk::Visualget_visual ()
 
Glib::RefPtr< Gdk::Screenget_screen ()
 
Glib::RefPtr< const Gdk::Screenget_screen () const
 
bool has_screen () const
 
Glib::RefPtr< Gdk::Displayget_display ()
 
Glib::RefPtr< const Gdk::Displayget_display () const
 
Glib::RefPtr< Gdk::Windowget_root_window ()
 
Glib::RefPtr< const Gdk::Windowget_root_window () const
 
Glib::RefPtr< Settingsget_settings ()
 
Glib::RefPtr< Clipboardget_clipboard (const Glib::ustring &selection)
 
Glib::RefPtr< const Clipboardget_clipboard (const Glib::ustring &selection) const
 
Glib::RefPtr< Gdk::Pixmapget_snapshot (Gdk::Rectangle &clip_rect) const
 
Glib::RefPtr< Gdk::Pixmapget_snapshot () const
 
void set_colormap (const Glib::RefPtr< const Gdk::Colormap > &colormap)
 
Gdk::EventMask get_events () const
 
void get_pointer (int &x, int &y) const
 
bool is_ancestor (Widget &ancestor) const
 
bool translate_coordinates (Widget &dest_widget, int src_x, int src_y, int &dest_x, int &dest_y)
 
bool has_rc_style () const
 
void set_style (const Glib::RefPtr< Style > &style)
 
void unset_style ()
 
void ensure_style ()
 
Glib::RefPtr< Styleget_style ()
 
Glib::RefPtr< const Styleget_style () const
 
void modify_style (const Glib::RefPtr< RcStyle > &style)
 
Glib::RefPtr< RcStyleget_modifier_style ()
 
Glib::RefPtr< const RcStyleget_modifier_style () const
 
void modify_fg (StateType state, const Gdk::Color &color)
 
void modify_bg (StateType state, const Gdk::Color &color)
 
void modify_bg_pixmap (StateType state, const Glib::ustring &pixmap_name)
 
void modify_text (StateType state, const Gdk::Color &color)
 
void modify_base (StateType state, const Gdk::Color &color)
 
void modify_cursor (const Gdk::Color &primary, const Gdk::Color &secondary)
 
void unset_cursor ()
 See modify_cursor(). More...
 
void modify_font (const Pango::FontDescription &font_desc)
 
void unset_fg (StateType state)
 
void unset_bg (StateType state)
 
void unset_text (StateType state)
 
void unset_base (StateType state)
 
void unset_font ()
 
template<class PropertyType >
void get_style_property (const Glib::ustring &the_property_name, PropertyType &value) const
 
Glib::RefPtr< Pango::Context > create_pango_context ()
 
Glib::RefPtr< Pango::Context > get_pango_context ()
 
Glib::RefPtr< Pango::Layout > create_pango_layout (const Glib::ustring &text)
 
Glib::RefPtr< Gdk::Pixbufrender_icon (const StockID &stock_id, IconSize size, const Glib::ustring &detail=Glib::ustring())
 
void set_composite_name (const Glib::ustring &name)
 
void unset_composite_name ()
 
Glib::ustring get_composite_name () const
 
void reset_rc_styles ()
 
void set_direction (TextDirection dir)
 
TextDirection get_direction ()
 
TextDirection get_direction () const
 
void shape_combine_mask (const Glib::RefPtr< const Gdk::Bitmap > &shape_mask, int offset_x, int offset_y)
 
void unset_shape_combine_mask ()
 
void input_shape_combine_mask (const Glib::RefPtr< const Gdk::Bitmap > &shape_mask, int offset_x, int offset_y)
 
void unset_input_shape_combine_mask ()
 
void reset_shapes ()
 
void path (Glib::ustring &path, Glib::ustring &path_reversed)
 Compute a widget's path of the form "GtkWindow.MyLabel". More...
 
void class_path (Glib::ustring &path, Glib::ustring &path_reversed)
 
Glib::ListHandle< Widget * > list_mnemonic_labels ()
 
Glib::ListHandle< const Widget * > list_mnemonic_labels () const
 
void add_mnemonic_label (Widget &label)
 
void remove_mnemonic_label (Widget &label)
 
void drag_get_data (const Glib::RefPtr< Gdk::DragContext > &context, Glib::ustring &target, guint32 time)
 
void drag_get_data (const Glib::RefPtr< Gdk::DragContext > &context, const Glib::ustring &target, guint32 time)
 
void drag_highlight ()
 
void drag_unhighlight ()
 
void drag_dest_set (DestDefaults flags=DestDefaults(0), Gdk::DragAction actions=Gdk::DragAction(0))
 
void drag_dest_set (const ArrayHandle_TargetEntry &targets, DestDefaults flags=DEST_DEFAULT_ALL, Gdk::DragAction actions=Gdk::ACTION_COPY)
 
void drag_dest_set_proxy (const Glib::RefPtr< Gdk::Window > &proxy_window, Gdk::DragProtocol protocol, bool use_coordinates)
 
void drag_dest_unset ()
 
Glib::ustring drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext > &context, const Glib::RefPtr< TargetList > &target_list) const
 
Glib::ustring drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext > &context) const
 
Glib::RefPtr< TargetListdrag_dest_get_target_list ()
 
Glib::RefPtr< const TargetListdrag_dest_get_target_list () const
 
void drag_dest_set_target_list (const Glib::RefPtr< TargetList > &target_list)
 
void drag_dest_add_text_targets ()
 
void drag_dest_add_image_targets ()
 
void drag_dest_add_uri_targets ()
 
void drag_source_set (const ArrayHandle_TargetEntry &targets, Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY)
 
void drag_source_unset ()
 
void drag_source_set_icon (const Glib::RefPtr< Gdk::Colormap > &colormap, const Glib::RefPtr< Gdk::Pixmap > &pixmap, const Glib::RefPtr< Gdk::Bitmap > &mask)
 
void drag_source_set_icon (const Glib::RefPtr< Gdk::Pixbuf > &pixbuf)
 
void drag_source_set_icon (const StockID &stock_id)
 
void drag_source_set_icon (const Glib::ustring &icon_name)
 
void drag_source_add_text_targets ()
 
void drag_source_add_uri_targets ()
 
void drag_source_add_image_targets ()
 
Glib::RefPtr< Gdk::DragContextdrag_begin (const Glib::RefPtr< TargetList > &targets, Gdk::DragAction actions, int button, GdkEvent *event)
 
bool drag_check_threshold (int start_x, int start_y, int current_x, int current_y)
 
void drag_set_as_icon (const Glib::RefPtr< Gdk::DragContext > &context, int hot_x, int hot_y)
 
void queue_resize_no_redraw ()
 
bool get_no_show_all () const
 
void set_no_show_all (bool no_show_all=true)
 
void set_parent (Widget &parent)
 
void unparent ()
 
void map ()
 
void unmap ()
 
void draw_insertion_cursor (Glib::RefPtr< Gdk::Drawable > drawable, const Gdk::Rectangle &area, const Gdk::Rectangle &location, bool is_primary, TextDirection direction, bool draw_arrow=true)
 
void set_tooltip_window (Window &window)
 
Windowget_tooltip_window ()
 
void trigger_tooltip_query ()
 
void set_tooltip_text (const Glib::ustring &text)
 
Glib::ustring get_tooltip_text () const
 
void set_tooltip_markup (const Glib::ustring &markup)
 
Glib::ustring get_tooltip_markup () const
 
void set_has_tooltip (bool has_tooltip=TRUE)
 
bool get_has_tooltip () const
 
bool has_no_window () const
 
bool is_realized () const
 
bool is_mapped () const
 
bool is_toplevel () const
 
bool is_drawable () const
 
bool is_visible () const
 
bool sensitive () const
 
bool app_paintable () const
 
bool receives_default () const
 
bool double_buffered () const
 
bool parent_sensitive () const
 
bool rc_style () const
 
bool is_composite_child () const
 
WidgetFlags get_flags () const
 
void set_flags (WidgetFlags flags)
 
void unset_flags (WidgetFlags flags)
 
Gtk::StateType get_saved_state () const
 
int get_width () const
 
int get_height () const
 
bool is_composited () const
 
Glib::RefPtr< Actionget_action ()
 
Glib::RefPtr< const Actionget_action () const
 
Requisition get_requisition () const
 
Glib::SignalProxy0< void > signal_show ()
 
Glib::SignalProxy0< void > signal_hide ()
 
Glib::SignalProxy0< void > signal_map ()
 Emitted on mapping of a widget to the screen. More...
 
Glib::SignalProxy0< void > signal_unmap ()
 
Glib::SignalProxy0< void > signal_realize ()
 Emitted on realization of a widget. More...
 
Glib::SignalProxy0< void > signal_unrealize ()
 
Glib::SignalProxy1< void, Requisition * > signal_size_request ()
 
Glib::SignalProxy1< void, Allocation & > signal_size_allocate ()
 
Glib::SignalProxy1< void, Gtk::StateTypesignal_state_changed ()
 
Glib::SignalProxy1< void, Widget * > signal_parent_changed ()
 Informs objects that their parent changed. More...
 
Glib::SignalProxy1< void, Widget * > signal_hierarchy_changed ()
 
Glib::SignalProxy1< void, const Glib::RefPtr< Gtk::Style > & > signal_style_changed ()
 
Glib::SignalProxy1< void, TextDirectionsignal_direction_changed ()
 
Glib::SignalProxy1< void, bool > signal_grab_notify ()
 
Glib::SignalProxy1< void, GParamSpec * > signal_child_notify ()
 
Glib::SignalProxy1< bool, bool > signal_mnemonic_activate ()
 
Glib::SignalProxy0< void > signal_grab_focus ()
 
Glib::SignalProxy1< bool, DirectionTypesignal_focus ()
 
Glib::SignalProxy1< bool, GdkEvent * > signal_event ()
 
Glib::SignalProxy1< void, GdkEvent * > signal_event_after ()
 
Glib::SignalProxy1< bool, GdkEventButton * > signal_button_press_event ()
 
Glib::SignalProxy1< bool, GdkEventButton * > signal_button_release_event ()
 
Glib::SignalProxy1< bool, GdkEventScroll * > signal_scroll_event ()
 
Glib::SignalProxy1< bool, GdkEventMotion * > signal_motion_notify_event ()
 
Glib::SignalProxy1< bool, GdkEventAny * > signal_delete_event ()
 
Glib::SignalProxy1< bool, GdkEventExpose * > signal_expose_event ()
 Event triggered by window requiring a refresh. More...
 
Glib::SignalProxy1< bool, GdkEventKey * > signal_key_press_event ()
 
Glib::SignalProxy1< bool, GdkEventKey * > signal_key_release_event ()
 
Glib::SignalProxy1< bool, GdkEventCrossing * > signal_enter_notify_event ()
 
Glib::SignalProxy1< bool, GdkEventCrossing * > signal_leave_notify_event ()
 
Glib::SignalProxy1< bool, GdkEventConfigure * > signal_configure_event ()
 
Glib::SignalProxy1< bool, GdkEventFocus * > signal_focus_in_event ()
 
Glib::SignalProxy1< bool, GdkEventFocus * > signal_focus_out_event ()
 
Glib::SignalProxy1< bool, GdkEventAny * > signal_map_event ()
 
Glib::SignalProxy1< bool, GdkEventAny * > signal_unmap_event ()
 
Glib::SignalProxy1< bool, GdkEventProperty * > signal_property_notify_event ()
 
Glib::SignalProxy1< bool, GdkEventSelection * > signal_selection_clear_event ()
 
Glib::SignalProxy1< bool, GdkEventSelection * > signal_selection_request_event ()
 
Glib::SignalProxy1< bool, GdkEventSelection * > signal_selection_notify_event ()
 
Glib::SignalProxy1< bool, GdkEventProximity * > signal_proximity_in_event ()
 
Glib::SignalProxy1< bool, GdkEventProximity * > signal_proximity_out_event ()
 
Glib::SignalProxy1< bool, GdkEventVisibility * > signal_visibility_notify_event ()
 
Glib::SignalProxy1< bool, GdkEventClient * > signal_client_event ()
 
Glib::SignalProxy1< bool, GdkEventAny * > signal_no_expose_event ()
 
Glib::SignalProxy1< bool, GdkEventWindowState * > signal_window_state_event ()
 
Glib::SignalProxy3< void, SelectionData &, guint, guint > signal_selection_get ()
 
Glib::SignalProxy2< void, const SelectionData &, guint > signal_selection_received ()
 
Glib::SignalProxy1< void, const Glib::RefPtr< Gdk::DragContext > & > signal_drag_begin ()
 
Glib::SignalProxy1< void, const Glib::RefPtr< Gdk::DragContext > & > signal_drag_end ()
 
Glib::SignalProxy4< void, const Glib::RefPtr< Gdk::DragContext > &, SelectionData &, guint, guint > signal_drag_data_get ()
 
Glib::SignalProxy1< void, const Glib::RefPtr< Gdk::DragContext > & > signal_drag_data_delete ()
 
Glib::SignalProxy2< bool, const Glib::RefPtr< Gdk::DragContext > &, DragResultsignal_drag_failed ()
 
Glib::SignalProxy2< void, const Glib::RefPtr< Gdk::DragContext > &, guint > signal_drag_leave ()
 
Glib::SignalProxy4< bool, const Glib::RefPtr< Gdk::DragContext > &, int, int, guint > signal_drag_motion ()
 
Glib::SignalProxy4< bool, const Glib::RefPtr< Gdk::DragContext > &, int, int, guint > signal_drag_drop ()
 
Glib::SignalProxy6< void, const Glib::RefPtr< Gdk::DragContext > &, int, int, const SelectionData &, guint, guint > signal_drag_data_received ()
 
Glib::SignalProxy1< void, const Glib::RefPtr< Gdk::Screen > & > signal_screen_changed ()
 
Glib::SignalProxy0< void > signal_composited_changed ()
 
Glib::SignalProxy0< bool > signal_popup_menu ()
 
Glib::SignalProxy4< bool, int, int, bool, const Glib::RefPtr< Tooltip > & > signal_query_tooltip ()
 
Glib::SignalProxy1< bool, GdkEventGrabBroken * > signal_grab_broken_event ()
 
Glib::SignalProxy1< bool, GdkEventExpose * > signal_damage_event ()
 
Glib::PropertyProxy< Glib::ustring > property_name ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_name () const
 
Glib::PropertyProxy< Container * > property_parent ()
 
Glib::PropertyProxy_ReadOnly< Container * > property_parent () const
 
Glib::PropertyProxy< int > property_width_request ()
 
Glib::PropertyProxy_ReadOnly< int > property_width_request () const
 
Glib::PropertyProxy< int > property_height_request ()
 
Glib::PropertyProxy_ReadOnly< int > property_height_request () const
 
Glib::PropertyProxy< bool > property_visible ()
 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 
Glib::PropertyProxy< bool > property_sensitive ()
 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 
Glib::PropertyProxy< bool > property_app_paintable ()
 
Glib::PropertyProxy_ReadOnly< bool > property_app_paintable () const
 
Glib::PropertyProxy< bool > property_can_focus ()
 
Glib::PropertyProxy_ReadOnly< bool > property_can_focus () const
 
Glib::PropertyProxy< bool > property_has_focus ()
 
Glib::PropertyProxy_ReadOnly< bool > property_has_focus () const
 
Glib::PropertyProxy< bool > property_is_focus ()
 
Glib::PropertyProxy_ReadOnly< bool > property_is_focus () const
 
Glib::PropertyProxy< bool > property_can_default ()
 
Glib::PropertyProxy_ReadOnly< bool > property_can_default () const
 
Glib::PropertyProxy< bool > property_has_default ()
 
Glib::PropertyProxy_ReadOnly< bool > property_has_default () const
 
Glib::PropertyProxy< bool > property_receives_default ()
 
Glib::PropertyProxy_ReadOnly< bool > property_receives_default () const
 
Glib::PropertyProxy_ReadOnly< bool > property_composite_child () const
 
Glib::PropertyProxy< Glib::RefPtr< Style > > property_style ()
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Style > > property_style () const
 
Glib::PropertyProxy< Gdk::EventMaskproperty_events ()
 
Glib::PropertyProxy_ReadOnly< Gdk::EventMaskproperty_events () const
 
Glib::PropertyProxy< Gdk::ExtensionModeproperty_extension_events ()
 
Glib::PropertyProxy_ReadOnly< Gdk::ExtensionModeproperty_extension_events () const
 
Glib::PropertyProxy< bool > property_has_tooltip ()
 
Glib::PropertyProxy_ReadOnly< bool > property_has_tooltip () const
 
Glib::PropertyProxy< Glib::ustring > property_tooltip_markup ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_tooltip_markup () const
 
Glib::PropertyProxy< Glib::ustring > property_tooltip_text ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_tooltip_text () const
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Window > > property_window () const
 
Glib::PropertyProxy< bool > property_no_show_all ()
 
Glib::PropertyProxy_ReadOnly< bool > property_no_show_all () const
 
Glib::PropertyProxy< bool > property_double_buffered ()
 
Glib::PropertyProxy_ReadOnly< bool > property_double_buffered () const
 
- Public Member Functions inherited from Gtk::Object
virtual ~Object ()
 
GtkObjectgobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkObjectgobj () const
 Provides access to the underlying C GtkObject. More...
 
Glib::PropertyProxy< void * > property_user_data ()
 
Glib::PropertyProxy_ReadOnly< void * > property_user_data () const
 

Protected Member Functions

virtual void on_plug_added ()
 This is a default handler for the signal signal_plug_added(). More...
 
virtual bool on_plug_removed ()
 This is a default handler for the signal signal_plug_removed(). More...
 
- Protected Member Functions inherited from Gtk::Container
virtual void on_add (Widget *widget)
 This is a default handler for the signal signal_add(). More...
 
virtual void on_remove (Widget *widget)
 This is a default handler for the signal signal_remove(). More...
 
virtual void on_check_resize ()
 This is a default handler for the signal signal_check_resize(). More...
 
virtual void on_set_focus_child (Widget *widget)
 This is a default handler for the signal signal_set_focus_child(). More...
 
 Container ()
 
virtual GType child_type_vfunc () const
 
virtual void forall_vfunc (gboolean include_internals, GtkCallback callback, gpointer callback_data)
 
virtual char * composite_name_vfunc (GtkWidget *child)
 
virtual void set_child_property_vfunc (GtkWidget *child, guint property_id, const GValue *value, GParamSpec *pspec)
 
virtual void get_child_property_vfunc (GtkWidget *child, guint property_id, GValue *value, GParamSpec *pspec) const
 
Glib::PropertyProxy< guint > property_border_width ()
 
Glib::PropertyProxy_ReadOnly< guint > property_border_width () const
 
Glib::PropertyProxy< ResizeModeproperty_resize_mode ()
 
Glib::PropertyProxy_ReadOnly< ResizeModeproperty_resize_mode () const
 
Glib::PropertyProxy_WriteOnly< Widget * > property_child ()
 
- Protected Member Functions inherited from Gtk::Widget
virtual void on_show ()
 This is a default handler for the signal signal_show(). More...
 
virtual void on_hide ()
 This is a default handler for the signal signal_hide(). More...
 
virtual void on_map ()
 This is a default handler for the signal signal_map(). More...
 
virtual void on_unmap ()
 This is a default handler for the signal signal_unmap(). More...
 
virtual void on_realize ()
 This is a default handler for the signal signal_realize(). More...
 
virtual void on_unrealize ()
 This is a default handler for the signal signal_unrealize(). More...
 
virtual void on_size_request (Requisition *requisition)
 This is a default handler for the signal signal_size_request(). More...
 
virtual void on_size_allocate (Allocation &allocation)
 This is a default handler for the signal signal_size_allocate(). More...
 
virtual void on_state_changed (Gtk::StateType previous_state)
 This is a default handler for the signal signal_state_changed(). More...
 
virtual void on_parent_changed (Widget *previous_parent)
 This is a default handler for the signal signal_parent_changed(). More...
 
virtual void on_hierarchy_changed (Widget *previous_toplevel)
 This is a default handler for the signal signal_hierarchy_changed(). More...
 
virtual void on_style_changed (const Glib::RefPtr< Gtk::Style > &previous_style)
 This is a default handler for the signal signal_style_changed(). More...
 
virtual void on_direction_changed (TextDirection direction)
 This is a default handler for the signal signal_direction_changed(). More...
 
virtual void on_grab_notify (bool was_grabbed)
 This is a default handler for the signal signal_grab_notify(). More...
 
virtual void on_child_notify (GParamSpec *pspec)
 This is a default handler for the signal signal_child_notify(). More...
 
virtual bool on_mnemonic_activate (bool group_cycling)
 This is a default handler for the signal signal_mnemonic_activate(). More...
 
virtual void on_grab_focus ()
 This is a default handler for the signal signal_grab_focus(). More...
 
virtual bool on_focus (DirectionType direction)
 This is a default handler for the signal signal_focus(). More...
 
virtual bool on_event (GdkEvent *event)
 This is a default handler for the signal signal_event(). More...
 
virtual bool on_button_press_event (GdkEventButton *event)
 This is a default handler for the signal signal_button_press_event(). More...
 
virtual bool on_button_release_event (GdkEventButton *event)
 This is a default handler for the signal signal_button_release_event(). More...
 
virtual bool on_scroll_event (GdkEventScroll *event)
 This is a default handler for the signal signal_scroll_event(). More...
 
virtual bool on_motion_notify_event (GdkEventMotion *event)
 This is a default handler for the signal signal_motion_notify_event(). More...
 
virtual bool on_delete_event (GdkEventAny *event)
 This is a default handler for the signal signal_delete_event(). More...
 
virtual bool on_expose_event (GdkEventExpose *event)
 This is a default handler for the signal signal_expose_event(). More...
 
virtual bool on_key_press_event (GdkEventKey *event)
 This is a default handler for the signal signal_key_press_event(). More...
 
virtual bool on_key_release_event (GdkEventKey *event)
 This is a default handler for the signal signal_key_release_event(). More...
 
virtual bool on_enter_notify_event (GdkEventCrossing *event)
 This is a default handler for the signal signal_enter_notify_event(). More...
 
virtual bool on_leave_notify_event (GdkEventCrossing *event)
 This is a default handler for the signal signal_leave_notify_event(). More...
 
virtual bool on_configure_event (GdkEventConfigure *event)
 This is a default handler for the signal signal_configure_event(). More...
 
virtual bool on_focus_in_event (GdkEventFocus *event)
 This is a default handler for the signal signal_focus_in_event(). More...
 
virtual bool on_focus_out_event (GdkEventFocus *event)
 This is a default handler for the signal signal_focus_out_event(). More...
 
virtual bool on_map_event (GdkEventAny *event)
 This is a default handler for the signal signal_map_event(). More...
 
virtual bool on_unmap_event (GdkEventAny *event)
 This is a default handler for the signal signal_unmap_event(). More...
 
virtual bool on_property_notify_event (GdkEventProperty *event)
 This is a default handler for the signal signal_property_notify_event(). More...
 
virtual bool on_selection_clear_event (GdkEventSelection *event)
 This is a default handler for the signal signal_selection_clear_event(). More...
 
virtual bool on_selection_request_event (GdkEventSelection *event)
 This is a default handler for the signal signal_selection_request_event(). More...
 
virtual bool on_selection_notify_event (GdkEventSelection *event)
 This is a default handler for the signal signal_selection_notify_event(). More...
 
virtual bool on_proximity_in_event (GdkEventProximity *event)
 This is a default handler for the signal signal_proximity_in_event(). More...
 
virtual bool on_proximity_out_event (GdkEventProximity *event)
 This is a default handler for the signal signal_proximity_out_event(). More...
 
virtual bool on_visibility_notify_event (GdkEventVisibility *event)
 This is a default handler for the signal signal_visibility_notify_event(). More...
 
virtual bool on_client_event (GdkEventClient *event)
 This is a default handler for the signal signal_client_event(). More...
 
virtual bool on_no_expose_event (GdkEventAny *event)
 This is a default handler for the signal signal_no_expose_event(). More...
 
virtual bool on_window_state_event (GdkEventWindowState *event)
 This is a default handler for the signal signal_window_state_event(). More...
 
virtual void on_selection_get (SelectionData &selection_data, guint info, guint time)
 This is a default handler for the signal signal_selection_get(). More...
 
virtual void on_selection_received (const SelectionData &selection_data, guint time)
 This is a default handler for the signal signal_selection_received(). More...
 
virtual void on_drag_begin (const Glib::RefPtr< Gdk::DragContext > &context)
 This is a default handler for the signal signal_drag_begin(). More...
 
virtual void on_drag_end (const Glib::RefPtr< Gdk::DragContext > &context)
 This is a default handler for the signal signal_drag_end(). More...
 
virtual void on_drag_data_get (const Glib::RefPtr< Gdk::DragContext > &context, SelectionData &selection_data, guint info, guint time)
 This is a default handler for the signal signal_drag_data_get(). More...
 
virtual void on_drag_data_delete (const Glib::RefPtr< Gdk::DragContext > &context)
 This is a default handler for the signal signal_drag_data_delete(). More...
 
virtual void on_drag_leave (const Glib::RefPtr< Gdk::DragContext > &context, guint time)
 This is a default handler for the signal signal_drag_leave(). More...
 
virtual bool on_drag_motion (const Glib::RefPtr< Gdk::DragContext > &context, int x, int y, guint time)
 This is a default handler for the signal signal_drag_motion(). More...
 
virtual bool on_drag_drop (const Glib::RefPtr< Gdk::DragContext > &context, int x, int y, guint time)
 This is a default handler for the signal signal_drag_drop(). More...
 
virtual void on_drag_data_received (const Glib::RefPtr< Gdk::DragContext > &context, int x, int y, const SelectionData &selection_data, guint info, guint time)
 This is a default handler for the signal signal_drag_data_received(). More...
 
virtual void on_screen_changed (const Glib::RefPtr< Gdk::Screen > &previous_screen)
 This is a default handler for the signal signal_screen_changed(). More...
 
virtual void dispatch_child_properties_changed_vfunc (guint p1, GParamSpec **p2)
 
virtual void show_all_vfunc ()
 
virtual void hide_all_vfunc ()
 
 Widget ()
 
void realize ()
 
void unrealize ()
 
void set_mapped (bool mapped=true)
 
void set_realized (bool realized=true)
 
void style_attach ()
 
void get_child_requisition (Requisition &requisition) const
 
void get_style_property_value (const Glib::ustring &the_property_name, Glib::ValueBase &value) const
 
void realize_if_needed ()
 

Related Functions

(Note that these are not member functions.)

Gtk::Socketwrap (GtkSocket *object, bool take_copy=false)
 

Additional Inherited Members

- Public Types inherited from Gtk::Container
typedef sigc::slot< void, Widget & > ForeachSlot
 
- Static Public Member Functions inherited from Gtk::Widget
static Widgetget_current_modal_grab ()
 
static void push_colormap (const Glib::RefPtr< const Gdk::Colormap > &cmap)
 
static void pop_colormap ()
 
static void push_composite_child ()
 
static void pop_composite_child ()
 
static void set_default_colormap (const Glib::RefPtr< const Gdk::Colormap > &colormap)
 
static Glib::RefPtr< Styleget_default_style ()
 
static Glib::RefPtr< Gdk::Colormapget_default_colormap ()
 
static Glib::RefPtr< Gdk::Visualget_default_visual ()
 
static void set_default_direction (TextDirection dir)
 
static TextDirection get_default_direction ()
 
static Widgetdrag_get_source_widget (const Glib::RefPtr< Gdk::DragContext > &context)
 

Detailed Description

Container for widgets from other processes. Together with Gtk::Plug, Gtk::Socket provides the ability to embed widgets from one process into another process in a fashion that is transparent to the user. One process creates a Gtk::Socket widget and, passes the that widget's window ID to the other process, which then creates a Gtk::Plug with that window ID. Any widgets contained in the Gtk::Plug then will appear inside the first applications window.

The socket's window ID is obtained by using get_id(). Before using this function, the socket must have been realized, and for hence, have been added to its parent.

Gtk::Socket socket;
parent.add(socket);
// The following call is only necessary if one of the ancestors of the
// socket is not yet visible
socket.realize();
cout << "The ID of the sockets window is: " << socket.get_id() << endl;
virtual void add(Widget &widget)
Gdk::NativeWindow get_id() const
void realize()

Note that if you pass the window ID of the socket to another process that will create a plug in the socket, you must make sure that the socket widget is not destroyed until that plug is created. Violating this rule will cause unpredictable consequences, the most likely consequence being that the plug will appear as a separate toplevel window. You can check if the plug has been created by examining the plug_window member of the GtkSocket structure returned by gobj(). If this field is non-NULL, then the plug has been successfully created inside of the socket.

When gtkmm is notified that the embedded window has been destroyed, then it will destroy the socket as well. You should always, therefore, be prepared for your sockets to be destroyed at any time when the main event loop is running.

The communication between a Gtk::Socket and a Gtk::Plug follows the XEmbed protocol. This protocol has also been implemented in other toolkits, e.g. Qt, allowing the same level of integration when embedding a Qt widget in gtkmm or vice versa.

Definition at line 91 of file socket.h.

Constructor & Destructor Documentation

◆ ~Socket()

virtual Gtk::Socket::~Socket ( )
virtual

◆ Socket()

Gtk::Socket::Socket ( )

Member Function Documentation

◆ add_id()

void Gtk::Socket::add_id ( Gdk::NativeWindow  window_id)

Adds an XEMBED client, such as a Gtk::Plug, to the Gtk::Socket. The client may be in the same process or in a different process.

To embed a Gtk::Plug in a Gtk::Socket, you can either create the Gtk::Plug with gtk_plug_new (0), call Gtk::Plug::get_id() to get the window ID of the plug, and then pass that to the add_id(), or you can call get_id() to get the window ID for the socket, and call Gtk::Plug::new() passing in that ID.

The Gtk::Socket must have already be added into a toplevel window before you can make this call.

Parameters
window_idThe window ID of a client participating in the XEMBED protocol.

◆ get_id()

Gdk::NativeWindow Gtk::Socket::get_id ( ) const

Gets the window ID of a Gtk::Socket widget, which can then be used to create a client embedded inside the socket, for instance with Gtk::Plug::new().

The Gtk::Socket must have already be added into a toplevel window before you can make this call.

Returns
The window ID for the socket.

◆ get_plug_window() [1/2]

Glib::RefPtr<Gdk::Window> Gtk::Socket::get_plug_window ( )

Retrieves the window of the plug. Use this to check if the plug has been created inside of the socket.

Returns
The window of the plug if available, or 0.

◆ get_plug_window() [2/2]

Glib::RefPtr<const Gdk::Window> Gtk::Socket::get_plug_window ( ) const

Retrieves the window of the plug. Use this to check if the plug has been created inside of the socket.

Returns
The window of the plug if available, or 0.

◆ gobj() [1/2]

GtkSocket* Gtk::Socket::gobj ( )
inline

Provides access to the underlying C GtkObject.

Definition at line 128 of file socket.h.

◆ gobj() [2/2]

const GtkSocket* Gtk::Socket::gobj ( ) const
inline

Provides access to the underlying C GtkObject.

Definition at line 131 of file socket.h.

◆ on_plug_added()

virtual void Gtk::Socket::on_plug_added ( )
protectedvirtual

This is a default handler for the signal signal_plug_added().

◆ on_plug_removed()

virtual bool Gtk::Socket::on_plug_removed ( )
protectedvirtual

This is a default handler for the signal signal_plug_removed().

◆ signal_plug_added()

Glib::SignalProxy0< void > Gtk::Socket::signal_plug_added ( )
Slot Prototype:
void on_my_plug_added()

◆ signal_plug_removed()

Glib::SignalProxy0< bool > Gtk::Socket::signal_plug_removed ( )
Slot Prototype:
bool on_my_plug_removed()

Friends And Related Function Documentation

◆ wrap()

Gtk::Socket * wrap ( GtkSocket object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file: