CtkAppChooserWidget

CtkAppChooserWidget — Application chooser widget that can be embedded in other widgets

Functions

CtkWidget * ctk_app_chooser_widget_new ()
void ctk_app_chooser_widget_set_show_default ()
gboolean ctk_app_chooser_widget_get_show_default ()
void ctk_app_chooser_widget_set_show_recommended ()
gboolean ctk_app_chooser_widget_get_show_recommended ()
void ctk_app_chooser_widget_set_show_fallback ()
gboolean ctk_app_chooser_widget_get_show_fallback ()
void ctk_app_chooser_widget_set_show_other ()
gboolean ctk_app_chooser_widget_get_show_other ()
void ctk_app_chooser_widget_set_show_all ()
gboolean ctk_app_chooser_widget_get_show_all ()
void ctk_app_chooser_widget_set_default_text ()
const gchar * ctk_app_chooser_widget_get_default_text ()

Properties

char * default-text Read / Write
gboolean show-all Read / Write / Construct
gboolean show-default Read / Write / Construct
gboolean show-fallback Read / Write / Construct
gboolean show-other Read / Write / Construct
gboolean show-recommended Read / Write / Construct

Signals

void application-activated Run First
void application-selected Run First
void populate-popup Run First

Types and Values

struct CtkAppChooserWidget
struct CtkAppChooserWidgetClass

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── CtkWidget
            ╰── CtkContainer
                ╰── CtkBox
                    ╰── CtkAppChooserWidget

Implemented Interfaces

CtkAppChooserWidget implements AtkImplementorIface, CtkBuildable, CtkOrientable and CtkAppChooser.

Includes

#include <ctk/ctk.h>

Description

CtkAppChooserWidget is a widget for selecting applications. It is the main building block for CtkAppChooserDialog. Most applications only need to use the latter; but you can use this widget as part of a larger widget if you have special needs.

CtkAppChooserWidget offers detailed control over what applications are shown, using the “show-default”, “show-recommended”, “show-fallback”, “show-other” and “show-all” properties. See the CtkAppChooser documentation for more information about these groups of applications.

To keep track of the selected application, use the “application-selected” and “application-activated” signals.

CSS nodes

CtkAppChooserWidget has a single CSS node with name appchooser.

Functions

ctk_app_chooser_widget_new ()

CtkWidget *
ctk_app_chooser_widget_new (const gchar *content_type);

Creates a new CtkAppChooserWidget for applications that can handle content of the given type.

Parameters

content_type

the content type to show applications for

  

Returns

a newly created CtkAppChooserWidget

Since: 3.0

ctk_app_chooser_widget_set_show_default ()

void
ctk_app_chooser_widget_set_show_default
                               (CtkAppChooserWidget *self,
                                gboolean setting);

Sets whether the app chooser should show the default handler for the content type in a separate section.

Parameters

self

a CtkAppChooserWidget

  

setting

the new value for “show-default”

  

Since: 3.0

ctk_app_chooser_widget_get_show_default ()

gboolean
ctk_app_chooser_widget_get_show_default
                               (CtkAppChooserWidget *self);

Returns the current value of the “show-default” property.

Parameters

self

a CtkAppChooserWidget

  

Returns

the value of “show-default”

Since: 3.0

ctk_app_chooser_widget_set_show_recommended ()

void
ctk_app_chooser_widget_set_show_recommended
                               (CtkAppChooserWidget *self,
                                gboolean setting);

Sets whether the app chooser should show recommended applications for the content type in a separate section.

Parameters

self

a CtkAppChooserWidget

  

setting

the new value for “show-recommended”

  

Since: 3.0

ctk_app_chooser_widget_get_show_recommended ()

gboolean
ctk_app_chooser_widget_get_show_recommended
                               (CtkAppChooserWidget *self);

Returns the current value of the “show-recommended” property.

Parameters

self

a CtkAppChooserWidget

  

Returns

the value of “show-recommended”

Since: 3.0

ctk_app_chooser_widget_set_show_fallback ()

void
ctk_app_chooser_widget_set_show_fallback
                               (CtkAppChooserWidget *self,
                                gboolean setting);

Sets whether the app chooser should show related applications for the content type in a separate section.

Parameters

self

a CtkAppChooserWidget

  

setting

the new value for “show-fallback”

  

Since: 3.0

ctk_app_chooser_widget_get_show_fallback ()

gboolean
ctk_app_chooser_widget_get_show_fallback
                               (CtkAppChooserWidget *self);

Returns the current value of the “show-fallback” property.

Parameters

self

a CtkAppChooserWidget

  

Returns

the value of “show-fallback”

Since: 3.0

ctk_app_chooser_widget_set_show_other ()

void
ctk_app_chooser_widget_set_show_other (CtkAppChooserWidget *self,
                                       gboolean setting);

Sets whether the app chooser should show applications which are unrelated to the content type.

Parameters

self

a CtkAppChooserWidget

  

setting

the new value for “show-other”

  

Since: 3.0

ctk_app_chooser_widget_get_show_other ()

gboolean
ctk_app_chooser_widget_get_show_other (CtkAppChooserWidget *self);

Returns the current value of the “show-other” property.

Parameters

self

a CtkAppChooserWidget

  

Returns

the value of “show-other”

Since: 3.0

ctk_app_chooser_widget_set_show_all ()

void
ctk_app_chooser_widget_set_show_all (CtkAppChooserWidget *self,
                                     gboolean setting);

Sets whether the app chooser should show all applications in a flat list.

Parameters

self

a CtkAppChooserWidget

  

setting

the new value for “show-all”

  

Since: 3.0

ctk_app_chooser_widget_get_show_all ()

gboolean
ctk_app_chooser_widget_get_show_all (CtkAppChooserWidget *self);

Returns the current value of the “show-all” property.

Parameters

self

a CtkAppChooserWidget

  

Returns

the value of “show-all”

Since: 3.0

ctk_app_chooser_widget_set_default_text ()

void
ctk_app_chooser_widget_set_default_text
                               (CtkAppChooserWidget *self,
                                const gchar *text);

Sets the text that is shown if there are not applications that can handle the content type.

Parameters

self

a CtkAppChooserWidget

  

text

the new value for “default-text”

  

ctk_app_chooser_widget_get_default_text ()

const gchar *
ctk_app_chooser_widget_get_default_text
                               (CtkAppChooserWidget *self);

Returns the text that is shown if there are not applications that can handle the content type.

Parameters

self

a CtkAppChooserWidget

  

Returns

the value of “default-text”

Since: 3.0

Types and Values

struct CtkAppChooserWidget

struct CtkAppChooserWidget;

struct CtkAppChooserWidgetClass

struct CtkAppChooserWidgetClass {
  CtkBoxClass parent_class;

  void (* application_selected)  (CtkAppChooserWidget *self,
                                  GAppInfo            *app_info);

  void (* application_activated) (CtkAppChooserWidget *self,
                                  GAppInfo            *app_info);

  void (* populate_popup)        (CtkAppChooserWidget *self,
                                  CtkMenu             *menu,
                                  GAppInfo            *app_info);
};

Members

application_selected ()

Signal emitted when an application item is selected from the widget’s list.

  

application_activated ()

Signal emitted when an application item is activated from the widget’s list.

  

populate_popup ()

Signal emitted when a context menu is about to popup over an application item.

  

Property Details

The “default-text” property

  “default-text”             char *

The “default-text” property determines the text that appears in the widget when there are no applications for the given content type. See also ctk_app_chooser_widget_set_default_text().

Owner: CtkAppChooserWidget

Flags: Read / Write

Default value: NULL

The “show-all” property

  “show-all”                 gboolean

If the “show-all” property is TRUE, the app chooser presents all applications in a single list, without subsections for default, recommended or related applications.

Owner: CtkAppChooserWidget

Flags: Read / Write / Construct

Default value: FALSE

The “show-default” property

  “show-default”             gboolean

The ::show-default property determines whether the app chooser should show the default handler for the content type in a separate section. If FALSE, the default handler is listed among the recommended applications.

Owner: CtkAppChooserWidget

Flags: Read / Write / Construct

Default value: FALSE

The “show-fallback” property

  “show-fallback”            gboolean

The “show-fallback” property determines whether the app chooser should show a section for fallback applications. If FALSE, the fallback applications are listed among the other applications.

Owner: CtkAppChooserWidget

Flags: Read / Write / Construct

Default value: FALSE

The “show-other” property

  “show-other”               gboolean

The “show-other” property determines whether the app chooser should show a section for other applications.

Owner: CtkAppChooserWidget

Flags: Read / Write / Construct

Default value: FALSE

The “show-recommended” property

  “show-recommended”         gboolean

The “show-recommended” property determines whether the app chooser should show a section for recommended applications. If FALSE, the recommended applications are listed among the other applications.

Owner: CtkAppChooserWidget

Flags: Read / Write / Construct

Default value: TRUE

Signal Details

The “application-activated” signal

void
user_function (CtkAppChooserWidget *self,
               GAppInfo            *application,
               gpointer             user_data)

Emitted when an application item is activated from the widget's list.

This usually happens when the user double clicks an item, or an item is selected and the user presses one of the keys Space, Shift+Space, Return or Enter.

Parameters

self

the object which received the signal

  

application

the activated GAppInfo

  

user_data

user data set when the signal handler was connected.

  

Flags: Run First

The “application-selected” signal

void
user_function (CtkAppChooserWidget *self,
               GAppInfo            *application,
               gpointer             user_data)

Emitted when an application item is selected from the widget's list.

Parameters

self

the object which received the signal

  

application

the selected GAppInfo

  

user_data

user data set when the signal handler was connected.

  

Flags: Run First

The “populate-popup” signal

void
user_function (CtkAppChooserWidget *self,
               CtkMenu             *menu,
               GAppInfo            *application,
               gpointer             user_data)

Emitted when a context menu is about to popup over an application item. Clients can insert menu items into the provided CtkMenu object in the callback of this signal; the context menu will be shown over the item if at least one item has been added to the menu.

Parameters

self

the object which received the signal

  

menu

the CtkMenu to populate

  

application

the current GAppInfo

  

user_data

user data set when the signal handler was connected.

  

Flags: Run First

Generated by GTK-Doc V1.36.1