Class: Gtk::Plug

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Instance Method Summary collapse

Instance Method Details

#construct(socket_id) ⇒ nil

Finish the initialization of plug for a given Gtk::Socket identified by socket_id. This function will generally only be used by classes deriving from Gtk::Plug.

Parameters:

  • socket_id (xlib::Window)

    the XID of the socket’s window.

Returns:

  • (nil)

#construct_for_display(display, socket_id) ⇒ nil

Finish the initialization of plug for a given Gtk::Socket identified by socket_id which is currently displayed on display. This function will generally only be used by classes deriving from Gtk::Plug.

Parameters:

  • display (Gdk::Display)

    the Gdk::Display associated with socket_id’s Gtk::Socket.

  • socket_id (xlib::Window)

    the XID of the socket’s window.

Returns:

  • (nil)

#embeddedTrueClass

Determines whether the plug is embedded in a socket.

Returns:

  • (TrueClass)

    true if the plug is embedded in a socket

#embedded=(embedded) ⇒ TrueClass

true if the plug is embedded in a socket.

Parameters:

  • embedded (TrueClass)

Returns:

  • (TrueClass)

    embedded

  • (TrueClass)

    embedded

#embedded?TrueClass

true if the plug is embedded in a socket.

Returns:

  • (TrueClass)

    embedded

#idxlib::Window

Gets the window ID of a Gtk::Plug widget, which can then be used to embed this window inside another window, for instance with gtk_socket_add_id().

Returns:

  • (xlib::Window)

    the window ID for the plug

#new(socket_id) ⇒ Gtk::Widget

Creates a new plug widget inside the Gtk::Socket identified by socket_id. If socket_id is 0, the plug is left “unplugged” and can later be plugged into a Gtk::Socket by gtk_socket_add_id().

Parameters:

  • socket_id (xlib::Window)

    the window ID of the socket, or 0.

Returns:

#new_for_display(display, socket_id) ⇒ Gtk::Widget

Create a new plug widget inside the Gtk::Socket identified by socket_id.

Parameters:

  • display (Gdk::Display)

    the Gdk::Display on which socket_id is displayed

  • socket_id (xlib::Window)

    the XID of the socket’s window.

Returns:

#socket_windowGdk::Window

The window of the socket the plug is embedded in.

Returns:

#socket_window=(socket_window) ⇒ Gdk::Window

The window of the socket the plug is embedded in.

Parameters:

Returns: