Interface

Atk-1.0 ▶ Atk ▶ Value ▶ Interface

Interface for implementing Value. Contains only the virtual methods that need to be implemented.

interface Interface {
    vfunc_get_current_value(): any;
    vfunc_get_increment(): number;
    vfunc_get_maximum_value(): any;
    vfunc_get_minimum_increment(): any;
    vfunc_get_minimum_value(): any;
    vfunc_get_range(): Atk.Range;
    vfunc_get_sub_ranges(): Atk.Range[];
    vfunc_get_value_and_text(): [number, string];
    vfunc_set_current_value(value: unknown): boolean;
    vfunc_set_value(new_value: number): void;
}

Hierarchy (View Summary)

Index
vfunc_get_current_value vfunc_get_increment vfunc_get_maximum_value vfunc_get_minimum_increment vfunc_get_minimum_value vfunc_get_range vfunc_get_sub_ranges vfunc_get_value_and_text vfunc_set_current_value vfunc_set_value

  • Gets the value of this object.

    Returns any

    Since 2.12. Use atk_value_get_value_and_text() instead.

  • Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform.

    Returns number

    2.12

  • Gets the maximum value of this object.

    Returns any

    Since 2.12. Use atk_value_get_range() instead.

  • Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform.

    Returns any

    1.12

    Since 2.12. Use atk_value_get_increment() instead.

  • Gets the minimum value of this object.

    Returns any

    Since 2.12. Use atk_value_get_range() instead.

Virtualvfunc_get_value_and_text

  • vfunc_get_value_and_text(): [number, string]

    Gets the current value and the human readable text alternative of obj. text is a newly created string, that must be freed by the caller. Can be NULL if no descriptor is available.

    Returns [number, string]

    2.12

  • Sets the value of this object.

    Parameters

    • Deprecatedvalue: unknown

      a GObject.Value which is the desired new accessible value.

    Returns boolean

    Since 2.12. Use atk_value_set_value() instead.

  • Sets the value of this object.

    This method is intended to provide a way to change the value of the object. In any case, it is possible that the value can't be modified (ie: a read-only component). If the value changes due this call, it is possible that the text could change, and will trigger an Atk.Value.SignalSignatures.value_changed | Atk.Value::value-changed signal emission.

    Note for implementors: the deprecated atk_value_set_current_value() method returned TRUE or FALSE depending if the value was assigned or not. In the practice several implementors were not able to decide it, and returned TRUE in any case. For that reason it is not required anymore to return if the value was properly assigned or not.

    Parameters

    • new_value: number

      a double which is the desired new accessible value.

    Returns void

    2.12