GimpUi.ZoomModel¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
class	`zoom_step` (zoom_type, scale, delta)
	`get_factor` ()
	`get_fraction` ()
	`set_range` (min, max)
	`zoom` (zoom_type, scale)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`fraction`	`str`	r	The zoom factor expressed as a fraction
`maximum`	`float`	r/w	Upper limit for the zoom factor
`minimum`	`float`	r/w	Lower limit for the zoom factor
`percentage`	`str`	r	The zoom factor expressed as a percentage
`value`	`float`	r/w	Zoom factor

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`zoomed`	Emitted when the zoom factor of the zoom model changes.

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class GimpUi.ZoomModel(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: GimpUi.ZoomModelClass

A model for zoom values.

classmethod new()¶

Returns:

a new GimpUi.ZoomModel.

Since GIMP 2.4

Return type:

GimpUi.ZoomModel

Creates a new GimpUi.ZoomModel.

classmethod zoom_step(zoom_type, scale, delta)¶

Parameters:

zoom_type (GimpUi.ZoomType) – the zoom type
scale (float) – ignored unless zoom_type == %GIMP_ZOOM_TO
delta (float) – the delta from a smooth zoom event

Returns:

the new scale factor

Since GIMP 2.4

Return type:

float

Utility function to calculate a new scale factor.

get_factor()¶

Returns:

the current scale factor

Since GIMP 2.4

Return type:

float

Retrieves the current zoom factor of self.

get_fraction()¶

Returns:

numerator:: return location for numerator
denominator:: return location for denominator

Return type:

(numerator: int, denominator: int)

Retrieves the current zoom factor of self as a fraction.

Since GIMP 2.4

set_range(min, max)¶

Parameters:

min (float) – new lower limit for zoom factor
max (float) – new upper limit for zoom factor

Sets the allowed range of the self.

Since GIMP 2.4

zoom(zoom_type, scale)¶

Parameters:

zoom_type (GimpUi.ZoomType) – the GimpUi.ZoomType
scale (float) – ignored unless zoom_type == %GIMP_ZOOM_TO

Since GIMP 2.4

Signal Details¶

GimpUi.ZoomModel.signals.zoomed(zoom_model, old_factor, new_factor)¶

Signal Name:

zoomed

Flags:

RUN_LAST

Parameters:

zoom_model (GimpUi.ZoomModel) – The object which received the signal
old_factor (float) – the zoom factor before it changes
new_factor (float) – the zoom factor after it has changed.

Emitted when the zoom factor of the zoom model changes.

Property Details¶

GimpUi.ZoomModel.props.fraction¶

Name:: fraction
Type:: str
Default Value:: '1:1'
Flags:: READABLE

The zoom factor expressed as a fraction.

GimpUi.ZoomModel.props.maximum¶

Name:: maximum
Type:: float
Default Value:: 256.0
Flags:: READABLE, WRITABLE

The maximum zoom factor.

GimpUi.ZoomModel.props.minimum¶

Name:: minimum
Type:: float
Default Value:: 0.00390625
Flags:: READABLE, WRITABLE

The minimum zoom factor.

GimpUi.ZoomModel.props.percentage¶

Name:: percentage
Type:: str
Default Value:: '100%'
Flags:: READABLE

The zoom factor expressed as percentage.

GimpUi.ZoomModel.props.value¶

Name:: value
Type:: float
Default Value:: 1.0
Flags:: READABLE, WRITABLE

The zoom factor.