gtkmm: Gdk::AppLaunchContext Class Reference

This is an implementation of Gio::AppLaunchContext that handles launching an application in a graphical context. More...

Inheritance diagram for Gdk::AppLaunchContext:

List of all members.

Public Member Functions

virtual ~AppLaunchContext ()
GdkAppLaunchContext* gobj ()
 Provides access to the underlying C GObject.

const GdkAppLaunchContext* gobj () const
 Provides access to the underlying C GObject.

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

void set_screen (const Glib::RefPtr< Gdk::Screen >& screen)
 Sets the screen on which applications will be launched when using this context.

void set_desktop (int desktop)
 Sets the workspace on which applications will be launched when using this context when running under a window manager that supports multiple workspaces, as described in the Extended Window Manager Hints.

void set_timestamp (guint32 timestamp)
 Sets the timestamp of context.

void set_icon (const Glib::RefPtr< Gio::Icon >& icon)
 Sets the icon for applications that are launched with this context.

void set_icon_name (const Glib::ustring& icon_name)
 Sets the icon for applications that are launched with this context.

- Public Member Functions inherited from Gio::AppLaunchContext
void setenv (const Glib::ustring &variable, const Glib::ustring &value)
void unsetenv (const Glib::ustring &variable)
std::vector< Glib::ustringget_environment () const
std::string get_display (const Glib::RefPtr< AppInfo > &info, const Glib::ListHandle< Glib::RefPtr< Gio::File > > &files)
std::string get_startup_notify_id (const Glib::RefPtr< AppInfo > &info, const Glib::ListHandle< Glib::RefPtr< Gio::File > > &files)
void launch_failed (const std::string &startup_notify_id)
void * get_data (const QueryQuark &key)
void set_data (const Quark &key, void *data)
void set_data (const Quark &key, void *data, DestroyNotify notify)
void remove_data (const QueryQuark &quark)
void * steal_data (const QueryQuark &quark)
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
void set_property (const Glib::ustring &property_name, const PropertyType &value)
void get_property (const Glib::ustring &property_name, PropertyType &value) const
void connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
void freeze_notify ()
void thaw_notify ()
virtual void reference () const
virtual void unreference () const
GObject * gobj_copy () const
Glib::RefPtr

< Gio::AppLaunchContext
wrap (GAppLaunchContext *object, bool take_copy=false)
Glib::RefPtr< Glib::Objectwrap (GObject *object, bool take_copy=false)
- Public Member Functions inherited from Glib::Object
void * get_data (const QueryQuark &key)
void set_data (const Quark &key, void *data)
void set_data (const Quark &key, void *data, DestroyNotify notify)
void remove_data (const QueryQuark &quark)
void * steal_data (const QueryQuark &quark)

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.

static Glib::RefPtr

< AppLaunchContext
create ()

Protected Member Functions

 AppLaunchContext ()
- Protected Member Functions inherited from Gio::AppLaunchContext
 Object ()
 Object (const Glib::ConstructParams &construct_params)
 Object (GObject *castitem)
virtual ~Object ()
 ObjectBase ()
 ObjectBase (const char *custom_type_name)
 ObjectBase (const std::type_info &custom_type_info)
virtual ~ObjectBase ()=0
void initialize (GObject *castitem)

Related Functions

(Note that these are not member functions.)

Glib::RefPtr

< Gdk::AppLaunchContext
wrap (GdkAppLaunchContext* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Additional Inherited Members

- Public Types inherited from Gio::AppLaunchContext
typedef void(* DestroyNotify )(gpointer data)
- Public Types inherited from Glib::Object

Detailed Description

This is an implementation of Gio::AppLaunchContext that handles launching an application in a graphical context.

It provides startup notification and allows to launch applications on a specific screen or workspace.

Since gtkmm 3.4:

Constructor & Destructor Documentation

virtual Gdk::AppLaunchContext::~AppLaunchContext ( )
virtual

Reimplemented from Gio::AppLaunchContext.

Gdk::AppLaunchContext::AppLaunchContext ( )
protected

Reimplemented from Gio::AppLaunchContext.


Member Function Documentation

static Glib::RefPtr<AppLaunchContext> Gdk::AppLaunchContext::create ( )
static

Reimplemented from Gio::AppLaunchContext.

static GType Gdk::AppLaunchContext::get_type ( )
static

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

Reimplemented from Gio::AppLaunchContext.

GdkAppLaunchContext* Gdk::AppLaunchContext::gobj ( )
inline

Provides access to the underlying C GObject.

Reimplemented from Gio::AppLaunchContext.

const GdkAppLaunchContext* Gdk::AppLaunchContext::gobj ( ) const
inline

Provides access to the underlying C GObject.

Reimplemented from Gio::AppLaunchContext.

GdkAppLaunchContext* Gdk::AppLaunchContext::gobj_copy ( )

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

Reimplemented from Gio::AppLaunchContext.

void Gdk::AppLaunchContext::set_desktop ( int  desktop)

Sets the workspace on which applications will be launched when using this context when running under a window manager that supports multiple workspaces, as described in the Extended Window Manager Hints.

When the workspace is not specified or desktop is set to -1, it is up to the window manager to pick one, typically it will be the current workspace.

Since gtkmm 2.14:
Parameters:
desktopThe number of a workspace, or -1.
void Gdk::AppLaunchContext::set_icon ( const Glib::RefPtr< Gio::Icon > &  icon)

Sets the icon for applications that are launched with this context.

Window Managers can use this information when displaying startup notification.

See also set_icon_name().

Since gtkmm 2.14:
Parameters:
iconA Icon, or 0.
void Gdk::AppLaunchContext::set_icon_name ( const Glib::ustring icon_name)

Sets the icon for applications that are launched with this context.

The icon_name will be interpreted in the same way as the Icon field in desktop files. See also set_icon().

If both icon and icon_name are set, the icon_name takes priority. If neither icon or icon_name is set, the icon is taken from either the file that is passed to launched application or from the AppInfo for the launched application itself.

Since gtkmm 2.14:
Parameters:
icon_nameAn icon name, or 0.
void Gdk::AppLaunchContext::set_screen ( const Glib::RefPtr< Gdk::Screen >&  screen)

Sets the screen on which applications will be launched when using this context.

See also set_display().

If both @a screen and @a display are set, the @a screen takes priority.
If neither @a screen or @a display are set, the default screen and
display are used.

\xrefitem since_2_14 1. @param screen A Gdk::Screen.
void Gdk::AppLaunchContext::set_timestamp ( guint32  timestamp)

Sets the timestamp of context.

The timestamp should ideally be taken from the event that triggered the launch.

Window managers can use this information to avoid moving the focus to the newly launched application when the user is busy typing in another window. This is also known as 'focus stealing prevention'.

Since gtkmm 2.14:
Parameters:
timestampA timestamp.

Friends And Related Function Documentation

Glib::RefPtr< Gdk::AppLaunchContext > wrap ( GdkAppLaunchContext *  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:
  • gdkmm/applaunchcontext.h