HdyKeypad

HdyKeypad — A keypad for dialing numbers

Functions

Properties

guint column-spacing Read / Write
GtkWidget * end-action Read / Write
GtkEntry * entry Read / Write
gboolean letters-visible Read / Write
guint row-spacing Read / Write
GtkWidget * start-action Read / Write
gboolean symbols-visible Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBin
                    ╰── HdyKeypad

Implemented Interfaces

HdyKeypad implements AtkImplementorIface and GtkBuildable.

Description

The HdyKeypad widget is a keypad for entering numbers such as phone numbers or PIN codes.

CSS nodes

HdyKeypad has a single CSS node with name keypad.

Functions

hdy_keypad_new ()

GtkWidget *
hdy_keypad_new (gboolean symbols_visible,
                gboolean letters_visible);

Create a new HdyKeypad widget.

Parameters

symbols_visible

whether the hash, plus, and asterisk symbols should be visible

 

letters_visible

whether the letters below the digits should be visible

 

Returns

the newly created HdyKeypad widget

Since: 0.0.12


hdy_keypad_set_row_spacing ()

void
hdy_keypad_set_row_spacing (HdyKeypad *self,
                            guint spacing);

Sets the amount of space between rows of self .

Parameters

self

a HdyKeypad

 

spacing

the amount of space to insert between rows

 

Since: 1.0


hdy_keypad_get_row_spacing ()

guint
hdy_keypad_get_row_spacing (HdyKeypad *self);

Returns the amount of space between the rows of self .

Parameters

self

a HdyKeypad

 

Returns

the row spacing of self

Since: 1.0


hdy_keypad_set_column_spacing ()

void
hdy_keypad_set_column_spacing (HdyKeypad *self,
                               guint spacing);

Sets the amount of space between columns of self .

Parameters

self

a HdyKeypad

 

spacing

the amount of space to insert between columns

 

Since: 1.0


hdy_keypad_get_column_spacing ()

guint
hdy_keypad_get_column_spacing (HdyKeypad *self);

Returns the amount of space between the columns of self .

Parameters

self

a HdyKeypad

 

Returns

the column spacing of self

Since: 1.0


hdy_keypad_set_letters_visible ()

void
hdy_keypad_set_letters_visible (HdyKeypad *self,
                                gboolean letters_visible);

Sets whether self should display the standard letters below the digits on its buttons.

Parameters

self

a HdyKeypad

 

letters_visible

whether the letters below the digits should be visible

 

Since: 1.0


hdy_keypad_get_letters_visible ()

gboolean
hdy_keypad_get_letters_visible (HdyKeypad *self);

Returns whether self should display the standard letters below the digits on its buttons.

Parameters

self

a HdyKeypad

 

Returns

whether the letters below the digits should be visible

Since: 1.0


hdy_keypad_set_symbols_visible ()

void
hdy_keypad_set_symbols_visible (HdyKeypad *self,
                                gboolean symbols_visible);

Sets whether self should display the hash and asterisk buttons, and should display the plus symbol at the bottom of its 0 button.

Parameters

self

a HdyKeypad

 

symbols_visible

whether the hash, plus, and asterisk symbols should be visible

 

Since: 1.0


hdy_keypad_get_symbols_visible ()

gboolean
hdy_keypad_get_symbols_visible (HdyKeypad *self);

Returns whether self should display the standard letters below the digits on its buttons.

Returns Whether self should display the hash and asterisk buttons, and should display the plus symbol at the bottom of its 0 button.

Parameters

self

a HdyKeypad

 

Returns

whether the hash, plus, and asterisk symbols should be visible

Since: 1.0


hdy_keypad_set_entry ()

void
hdy_keypad_set_entry (HdyKeypad *self,
                      GtkEntry *entry);

Binds entry to self and blocks any input which wouldn't be possible to type with with the keypad.

Parameters

self

a HdyKeypad

 

entry

a GtkEntry.

[nullable]

Since: 0.0.12


hdy_keypad_get_entry ()

GtkEntry *
hdy_keypad_get_entry (HdyKeypad *self);

Get the connected entry. See hdy_keypad_set_entry() for details.

Parameters

self

a HdyKeypad

 

Returns

the set GtkEntry or NULL if no widget was set.

[transfer none]

Since: 1.0


hdy_keypad_set_start_action ()

void
hdy_keypad_set_start_action (HdyKeypad *self,
                             GtkWidget *start_action);

Sets the widget for the lower left corner (or right, in RTL locales) of self .

Parameters

self

a HdyKeypad

 

start_action

the start action widget.

[nullable]

Since: 1.0


hdy_keypad_get_start_action ()

GtkWidget *
hdy_keypad_get_start_action (HdyKeypad *self);

Returns the widget for the lower left corner (or right, in RTL locales) of self .

Parameters

self

a HdyKeypad

 

Returns

the start action widget.

[transfer none][nullable]

Since: 1.0


hdy_keypad_set_end_action ()

void
hdy_keypad_set_end_action (HdyKeypad *self,
                           GtkWidget *end_action);

Sets the widget for the lower right corner (or left, in RTL locales) of self .

Parameters

self

a HdyKeypad

 

end_action

the end action widget.

[nullable]

Since: 1.0


hdy_keypad_get_end_action ()

GtkWidget *
hdy_keypad_get_end_action (HdyKeypad *self);

Returns the widget for the lower right corner (or left, in RTL locales) of self .

Parameters

self

a HdyKeypad

 

Returns

the end action widget.

[transfer none][nullable]

Since: 1.0

Types and Values

HDY_TYPE_KEYPAD

#define HDY_TYPE_KEYPAD (hdy_keypad_get_type())

struct HdyKeypadClass

struct HdyKeypadClass {
  GtkBinClass parent_class;
};

Members


HdyKeypad

typedef struct _HdyKeypad HdyKeypad;

Property Details

The “column-spacing” property

  “column-spacing”           guint

The amount of space between two consecutive columns.

Flags: Read / Write

Allowed values: <= 32767

Default value: 6

Since: 1.0


The “end-action” property

  “end-action”               GtkWidget *

The widget for the lower end corner of self .

Flags: Read / Write

Since: 1.0


The “entry” property

  “entry”                    GtkEntry *

The entry widget connected to the keypad. See hdy_keypad_set_entry() for details.

Flags: Read / Write

Since: 1.0


The “letters-visible” property

  “letters-visible”          gboolean

Whether the keypad should display the standard letters below the digits on its buttons.

Flags: Read / Write

Default value: TRUE

Since: 1.0


The “row-spacing” property

  “row-spacing”              guint

The amount of space between two consecutive rows.

Flags: Read / Write

Allowed values: <= 32767

Default value: 6

Since: 1.0


The “start-action” property

  “start-action”             GtkWidget *

The widget for the lower start corner of self .

Flags: Read / Write

Since: 1.0


The “symbols-visible” property

  “symbols-visible”          gboolean

Whether the keypad should display the hash and asterisk buttons, and should display the plus symbol at the bottom of its 0 button.

Flags: Read / Write

Default value: TRUE

Since: 1.0