CtkShortcutsSection

CtkShortcutsSection — Represents an application mode in a CtkShortcutsWindow

Properties

guint max-height Read / Write
char * section-name Read / Write
char * title Read / Write
char * view-name Read / Write

Signals

gboolean change-current-page Action

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── CtkWidget
            ╰── CtkContainer
                ╰── CtkBox
                    ╰── CtkShortcutsSection

Implemented Interfaces

CtkShortcutsSection implements AtkImplementorIface, CtkBuildable and CtkOrientable.

Includes

#include <ctk/ctk.h>

Description

A CtkShortcutsSection collects all the keyboard shortcuts and gestures for a major application mode. If your application needs multiple sections, you should give each section a unique “section-name” and a “title” that can be shown in the section selector of the CtkShortcutsWindow.

The “max-height” property can be used to influence how the groups in the section are distributed over pages and columns.

This widget is only meant to be used with CtkShortcutsWindow.

Functions

Types and Values

CtkShortcutsSection

typedef struct _CtkShortcutsSection CtkShortcutsSection;

Property Details

The “max-height” property

  “max-height”               guint

The maximum number of lines to allow per column. This property can be used to influence how the groups in this section are distributed across pages and columns. The default value of 15 should work in most cases.

Owner: CtkShortcutsSection

Flags: Read / Write

Default value: 15


The “section-name” property

  “section-name”             char *

A unique name to identify this section among the sections added to the CtkShortcutsWindow. Setting the “section-name” property to this string will make this section shown in the CtkShortcutsWindow.

Owner: CtkShortcutsSection

Flags: Read / Write

Default value: NULL


The “title” property

  “title”                    char *

The string to show in the section selector of the CtkShortcutsWindow for this section. If there is only one section, you don't need to set a title, since the section selector will not be shown in this case.

Owner: CtkShortcutsSection

Flags: Read / Write

Default value: NULL


The “view-name” property

  “view-name”                char *

A view name to filter the groups in this section by. See “view”.

Applications are expected to use the “view-name” property for this purpose.

Owner: CtkShortcutsSection

Flags: Read / Write

Default value: NULL

Signal Details

The “change-current-page” signal

gboolean
user_function (CtkShortcutsSection *ctkshortcutssection,
               int                  arg1,
               gpointer             user_data)

Flags: Action