gtkmm  3.3.20
Public Member Functions | Protected Member Functions | Related Functions
Gtk::Plug Class Reference
Inheritance diagram for Gtk::Plug:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~Plug ()
GtkPlug* gobj ()
 Provides access to the underlying C GtkObject.
const GtkPlug* gobj () const
 Provides access to the underlying C GtkObject.
 Plug ()
 Plug (::Window socket_id)
 Plug (const Glib::RefPtr< Gdk::Display >& display,::Window socket_id)
::Window get_id () const
 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().
bool get_embedded () const
 Determines whether the plug is embedded in a socket.
Glib::RefPtr< Gdk::Windowget_socket_window ()
 Retrieves the socket the plug is embedded in.
Glib::RefPtr< const Gdk::Windowget_socket_window () const
 Retrieves the socket the plug is embedded in.
Glib::PropertyProxy_ReadOnly
< bool > 
property_embedded () const
 Whether the plug is embedded.
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< Gdk::Window > > 
property_socket_window () const
 The window of the socket the plug is embedded in.
Glib::SignalProxy0< void > signal_embedded ()

Protected Member Functions

virtual void on_embedded ()
 This is a default handler for the signal signal_embedded().

Related Functions

(Note that these are not member functions.)

Gtk::Plugwrap (GtkPlug* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Constructor & Destructor Documentation

virtual Gtk::Plug::~Plug ( ) [virtual]
Gtk::Plug::Plug ( ::Window  socket_id) [explicit]
Gtk::Plug::Plug ( const Glib::RefPtr< Gdk::Display >&  display,
::Window  socket_id 
)

Member Function Documentation

bool Gtk::Plug::get_embedded ( ) const

Determines whether the plug is embedded in a socket.

Since gtkmm 2.14:
Returns:
true if the plug is embedded in a socket.

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:
The window ID for the plug.

Retrieves the socket the plug is embedded in.

Since gtkmm 2.14:
Returns:
The window of the socket, or 0.

Retrieves the socket the plug is embedded in.

Since gtkmm 2.14:
Returns:
The window of the socket, or 0.
GtkPlug* Gtk::Plug::gobj ( ) [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Window.

const GtkPlug* Gtk::Plug::gobj ( ) const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Window.

virtual void Gtk::Plug::on_embedded ( ) [protected, virtual]

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

Whether the plug is embedded.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

The window of the socket the plug is embedded in.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Slot Prototype:
void on_my_embedded()

Gets emitted when the plug becomes embedded in a socket.


Friends And Related Function Documentation

Gtk::Plug* wrap ( GtkPlug *  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: