Panel.Position¶

Subclasses:: None

Methods¶

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

class	`new` ()
class	`new_from_variant` (variant)
	`equal` (b)
	`get_area` ()
	`get_area_set` ()
	`get_column` ()
	`get_column_set` ()
	`get_depth` ()
	`get_depth_set` ()
	`get_row` ()
	`get_row_set` ()
	`is_indeterminate` ()
	`set_area` (area)
	`set_area_set` (area_set)
	`set_column` (column)
	`set_column_set` (column_set)
	`set_depth` (depth)
	`set_depth_set` (depth_set)
	`set_row` (row)
	`set_row_set` (row_set)
	`to_variant` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags
`area`	`Panel.Area`	r/w/en
`area-set`	`bool`	r/w/en
`column`	`int`	r/w/en
`column-set`	`bool`	r/w/en
`depth`	`int`	r/w/en
`depth-set`	`bool`	r/w/en
`row`	`int`	r/w/en
`row-set`	`bool`	r/w/en

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Panel.Position(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Panel.PositionClass

Specifies a position in the dock. You receive a Panel.Position in the handler to [signal`PanelDock`:py:func:::create-frame<Panel.Position.signals.create_frame>].

classmethod new()¶

Returns:: a newly created instance of Panel.Position.
Return type:: Panel.Position

Create a position.

classmethod new_from_variant(variant)¶

Parameters:: variant (GLib.Variant) – a GLib.Variant
Returns:: A newly created Panel.Position from the GLib.Variant.
Return type:: Panel.Position or None

Create a Panel.Position from a GLib.Variant.

equal(b)¶

Parameters:: b (Panel.Position) – another Panel.Position
Returns:: whether the two pane positions are equal.
Return type:: bool

Compares two Panel.Position.

get_area()¶

Returns:: the area.
Return type:: Panel.Area

Gets the area.

get_area_set()¶

Returns:: the wether the area is set.
Return type:: bool

Gets wether the area is set.

get_column()¶

Return type:: int

get_column_set()¶

Return type:: bool

get_depth()¶

Return type:: int

get_depth_set()¶

Return type:: bool

get_row()¶

Return type:: int

get_row_set()¶

Return type:: bool

is_indeterminate()¶

Returns:: whether the position is indeterminate.
Return type:: bool

Tells is the position is indeterminate.

set_area(area)¶

Parameters:: area (Panel.Area) – the Panel.Area

Sets the area.

set_area_set(area_set)¶

Parameters:: area_set (bool) – whether the area is set.

Sets whether the area is set.

set_column(column)¶

Parameters:: column (int) –

set_column_set(column_set)¶

Parameters:: column_set (bool) –

set_depth(depth)¶

Parameters:: depth (int) –

set_depth_set(depth_set)¶

Parameters:: depth_set (bool) –

set_row(row)¶

Parameters:: row (int) –

set_row_set(row_set)¶

Parameters:: row_set (bool) –

to_variant()¶

Returns:: the new GLib.Variant containing the positon values
Return type:: GLib.Variant or None

Convert a Panel.Position to a GLib.Variant.

Property Details¶

Panel.Position.props.area¶

Name:: area
Type:: Panel.Area
Default Value:: Panel.Area.CENTER
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The area.

Panel.Position.props.area_set¶

Name:: area-set
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The area is set.

Panel.Position.props.column¶

Name:: column
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The column in the position.

Panel.Position.props.column_set¶

Name:: column-set
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The column is set.

Panel.Position.props.depth¶

Name:: depth
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Panel.Position.props.depth_set¶

Name:: depth-set
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Panel.Position.props.row¶

Name:: row
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Panel.Position.props.row_set¶

Name:: row-set
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY