gtkmm 3.24.7
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::WindowGroup Class Reference

Limit the effect of grabs. More...

#include <gtkmm/windowgroup.h>

Inherits Glib::Object.

Public Member Functions

 WindowGroup (WindowGroup && src) noexcept
 
WindowGroupoperator= (WindowGroup && src) noexcept
 
 ~WindowGroup () noexcept override
 
GtkWindowGroup * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkWindowGroup * gobj () const
 Provides access to the underlying C GObject. More...
 
GtkWindowGroup * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
void add_window (Window & window)
 Adds a window to a Gtk::WindowGroup. More...
 
void remove_window (Window & window)
 Removes a window from a Gtk::WindowGroup. More...
 
std::vector< Window * > list_windows ()
 Returns a list of the Gtk::Windows that belong to window_group. More...
 
std::vector< const Window * > list_windows () const
 Returns a list of the Gtk::Windows that belong to window_group. More...
 
Widgetget_current_grab ()
 Gets the current grab widget of the given group, see gtk_grab_add(). More...
 
const Widgetget_current_grab () const
 Gets the current grab widget of the given group, see gtk_grab_add(). More...
 
Widgetget_current_grab (const Glib::RefPtr< const Gdk::Device > & device)
 Returns the current grab widget for device, or nullptr if none. More...
 
const Widgetget_current_grab (const Glib::RefPtr< const Gdk::Device > & device) const
 Returns the current grab widget for device, or nullptr if none. More...
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
static Glib::RefPtr< WindowGroupcreate ()
 

Protected Member Functions

 WindowGroup ()
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gtk::WindowGroupwrap (GtkWindowGroup * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

Limit the effect of grabs.

Constructor & Destructor Documentation

◆ WindowGroup() [1/2]

Gtk::WindowGroup::WindowGroup ( WindowGroup &&  src)
noexcept

◆ ~WindowGroup()

Gtk::WindowGroup::~WindowGroup ( )
overridenoexcept

◆ WindowGroup() [2/2]

Gtk::WindowGroup::WindowGroup ( )
protected

Member Function Documentation

◆ add_window()

void Gtk::WindowGroup::add_window ( Window window)

Adds a window to a Gtk::WindowGroup.

Parameters
windowThe Gtk::Window to add.

◆ create()

static Glib::RefPtr< WindowGroup > Gtk::WindowGroup::create ( )
static

◆ get_current_grab() [1/4]

Widget * Gtk::WindowGroup::get_current_grab ( )

Gets the current grab widget of the given group, see gtk_grab_add().

Since gtkmm 2.22:
Returns
The current grab widget of the group.

◆ get_current_grab() [2/4]

const Widget * Gtk::WindowGroup::get_current_grab ( ) const

Gets the current grab widget of the given group, see gtk_grab_add().

Since gtkmm 2.22:
Returns
The current grab widget of the group.

◆ get_current_grab() [3/4]

Widget * Gtk::WindowGroup::get_current_grab ( const Glib::RefPtr< const Gdk::Device > &  device)

Returns the current grab widget for device, or nullptr if none.

Since gtkmm 3.0:
Parameters
deviceA Gdk::Device.
Returns
The grab widget, or nullptr.

◆ get_current_grab() [4/4]

const Widget * Gtk::WindowGroup::get_current_grab ( const Glib::RefPtr< const Gdk::Device > &  device) const

Returns the current grab widget for device, or nullptr if none.

Since gtkmm 3.0:
Parameters
deviceA Gdk::Device.
Returns
The grab widget, or nullptr.

◆ get_type()

static GType Gtk::WindowGroup::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GtkWindowGroup * Gtk::WindowGroup::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkWindowGroup * Gtk::WindowGroup::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkWindowGroup * Gtk::WindowGroup::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ list_windows() [1/2]

std::vector< Window * > Gtk::WindowGroup::list_windows ( )

Returns a list of the Gtk::Windows that belong to window_group.

Since gtkmm 2.14:
Returns
A newly-allocated list of windows inside the group.

◆ list_windows() [2/2]

std::vector< const Window * > Gtk::WindowGroup::list_windows ( ) const

Returns a list of the Gtk::Windows that belong to window_group.

Since gtkmm 2.14:
Returns
A newly-allocated list of windows inside the group.

◆ operator=()

WindowGroup & Gtk::WindowGroup::operator= ( WindowGroup &&  src)
noexcept

◆ remove_window()

void Gtk::WindowGroup::remove_window ( Window window)

Removes a window from a Gtk::WindowGroup.

Parameters
windowThe Gtk::Window to remove.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::WindowGroup > wrap ( GtkWindowGroup *  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.