GFC Logo GFC Title Logo
Reference Manual
Main Page  |  Namespace List  |  Alphabetical List  |  Class List  |  File List

GFC::Gtk::Plug Class Reference

A GtkPlug C++ wrapper class. More...

#include <gfc/gtk/plug.hh>

Inheritance diagram for GFC::Gtk::Plug:

GFC::Gtk::Window GFC::Gtk::Bin GFC::Gtk::Container GFC::Gtk::Widget GFC::Gtk::Object GFC::Atk::Implementor GFC::G::Object GFC::G::TypeInterface GFC::G::TypeInstance GFC::G::TypeInstance GFC::Trackable GFC::Trackable List of all members.

Signal Prototypes

Public Member Functions

Constructors
Accessors
Signal Proxies

Protected Member Functions

Constructors

Detailed Description

A GtkPlug C++ wrapper class.

Together with Socket, Plug 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 Socket widget and, passes the ID of that widgets window to the other process, which then creates a Plug with that window ID. Any widgets contained in the Plug then will appear inside the first applications window.


Constructor & Destructor Documentation

GFC::Gtk::Plug::Plug GtkPlug *  plug,
bool  owns_reference = false
[explicit, protected]
 

Construct a new Plug from an existing GtkPlug.

Parameters:
plug A pointer to a GtkPlug.
owns_reference Set false if the initial reference count is floating, set true if it's not.

The plug can be a newly created GtkPlug or an existing GtkPlug (see G::Object::Object).

GFC::Gtk::Plug::Plug GdkNativeWindow  socket_id,
const Gdk::Display display = 0
 

Constructs a new plug widget inside the Socket identified by socket_id.

Parameters:
socket_id The XID of the socket's window.
display The Gdk::Display on which socket_id is displayed, or null for the default display.

If socket_id is 0, the plug is left "unplugged" and can later be plugged into a Socket by Gtk::Socket::add_id().

Note: The default GDK display is the only display in the absence of MultiHead support.


Member Function Documentation

GdkNativeWindow GFC::Gtk::Plug::get_id  )  const
 

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

Returns:
The window ID for the plug.


Member Data Documentation

const EmbeddedSignalType GFC::Gtk::Plug::embedded_signal [static, protected]
 

Embedded signal (see sig_embedded()).

Calls a slot with the signature:

             void function();


The documentation for this class was generated from the following file:
Generated on Tue Aug 24 00:34:41 2004 for GFC-UI by doxygen 1.3.8