CtkMisc: CTK+ 3 Reference Manual

## CtkMisc CtkMisc — Base class for widgets with alignments and padding |

## Functions

void | ctk_misc_set_alignment ()
void | ctk_misc_set_padding ()
void | ctk_misc_get_alignment ()
void | ctk_misc_get_padding ()

## Properties

float | xalign | Read / Write
int | xpad | Read / Write
float | yalign | Read / Write
int | ypad | Read / Write

## Types and Values

struct | CtkMisc

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── CtkWidget
                ╰── CtkMisc
                    ├── CtkLabel
                    ├── CtkArrow
                    ╰── CtkImage

## Implemented Interfaces

CtkMisc implements AtkImplementorIface and CtkBuildable.

## Includes

    #include <ctk/ctk.h>

## Description

The CtkMisc widget is an abstract widget which is not useful itself, but is used to derive subclasses which have alignment and padding attributes.

The horizontal and vertical padding attributes allows extra space to be added around the widget.

The horizontal and vertical alignment attributes enable the widget to be positioned within its allocated area. Note that if the widget is added to a container in such a way that it expands automatically to fill its allocated area, the alignment settings will not alter the widget's position.

Note that the desired effect can in most cases be achieved by using the “halign”, “valign” and “margin” properties on the child widget, so CtkMisc should not be used in new code. To reflect this fact, all CtkMisc API has been deprecated.

## Functions

### ctk_misc_set_alignment ()

    void
    ctk_misc_set_alignment (CtkMisc *misc,
                            gfloat xalign,
                            gfloat yalign);

`ctk_misc_set_alignment` has been deprecated since version 3.14 and should not be used in newly-written code.

Use CtkWidget's alignment (“halign” and “valign”) and margin properties or CtkLabel's “xalign” and “yalign” properties.

Sets the alignment of the widget.

#### Parameters

misc | a CtkMisc. |
xalign | the horizontal alignment, from 0 (left) to 1 (right). |
yalign | the vertical alignment, from 0 (top) to 1 (bottom). |

### ctk_misc_set_padding ()

    void
    ctk_misc_set_padding (CtkMisc *misc,
                          gint xpad,
                          gint ypad);

`ctk_misc_set_padding` has been deprecated since version 3.14 and should not be used in newly-written code.

Use CtkWidget alignment and margin properties.

Sets the amount of space to add around the widget.

#### Parameters

misc | a CtkMisc. |
xpad | the amount of space to add on the left and right of the widget, in pixels. |
ypad | the amount of space to add on the top and bottom of the widget, in pixels. |

### ctk_misc_get_alignment ()

    void
    ctk_misc_get_alignment (CtkMisc *misc,
                            gfloat *xalign,
                            gfloat *yalign);

`ctk_misc_get_alignment` has been deprecated since version 3.14 and should not be used in newly-written code.

Use CtkWidget alignment and margin properties.

Gets the X and Y alignment of the widget within its allocation. See `ctk_misc_set_alignment()`.

#### Parameters

misc | a CtkMisc |
xalign | location to store X alignment of `misc` , or `NULL`. | [out][allow-none]
yalign | location to store Y alignment of `misc` , or `NULL`. | [out][allow-none]

### ctk_misc_get_padding ()

    void
    ctk_misc_get_padding (CtkMisc *misc,
                          gint *xpad,
                          gint *ypad);

`ctk_misc_get_padding` has been deprecated since version 3.14 and should not be used in newly-written code.

Use CtkWidget alignment and margin properties.

Gets the padding in the X and Y directions of the widget. See `ctk_misc_set_padding()`.

#### Parameters

misc | a CtkMisc |
xpad | location to store padding in the X direction, or `NULL`. | [out][allow-none]
ypad | location to store padding in the Y direction, or `NULL`. | [out][allow-none]

## Types and Values

### struct CtkMisc

    struct CtkMisc;

## Property Details

### The `“xalign”` property

      “xalign”                   float

The horizontal alignment. A value of 0.0 means left alignment (or right on RTL locales); a value of 1.0 means right alignment (or left on RTL locales).

`CtkMisc:xalign` has been deprecated since version 3.14 and should not be used in newly-written code.

Use `ctk_widget_set_halign()` instead. If you are using CtkLabel, use “xalign” instead.

Owner: CtkMisc

Flags: Read / Write

Allowed values: [0,1]

Default value: 0.5

### The `“xpad”` property

      “xpad”                     int

The amount of space to add on the left and right of the widget, in pixels.

`CtkMisc:xpad` has been deprecated since version 3.14 and should not be used in newly-written code.

Use `ctk_widget_set_margin_start()` and `ctk_widget_set_margin_end()` instead

Owner: CtkMisc

Flags: Read / Write

Allowed values: >= 0

Default value: 0

### The `“yalign”` property

      “yalign”                   float

The vertical alignment. A value of 0.0 means top alignment; a value of 1.0 means bottom alignment.

`CtkMisc:yalign` has been deprecated since version 3.14 and should not be used in newly-written code.

Use `ctk_widget_set_valign()` instead. If you are using CtkLabel, use “yalign” instead.

Owner: CtkMisc

Flags: Read / Write

Allowed values: [0,1]

Default value: 0.5

### The `“ypad”` property

      “ypad”                     int

The amount of space to add on the top and bottom of the widget, in pixels.

`CtkMisc:ypad` has been deprecated since version 3.14 and should not be used in newly-written code.

Use `ctk_widget_set_margin_top()` and `ctk_widget_set_margin_bottom()` instead

Owner: CtkMisc

Flags: Read / Write

Allowed values: >= 0

Default value: 0