Ggit.CheckoutOptions¶

Subclasses:: None

Methods¶

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

class	`new` ()
	`get_ancestor_label` ()
	`get_baseline` ()
	`get_dir_mode` ()
	`get_disable_filters` ()
	`get_file_mode` ()
	`get_file_open_flags` ()
	`get_notify_flags` ()
	`get_our_label` ()
	`get_paths` ()
	`get_strategy` ()
	`get_target_directory` ()
	`get_their_label` ()
	`set_ancestor_label` (label)
	`set_baseline` (tree)
	`set_dir_mode` (dir_mode)
	`set_disable_filters` (disable)
	`set_file_mode` (file_mode)
	`set_file_open_flags` (flags)
	`set_notify_flags` (flags)
	`set_our_label` (label)
	`set_paths` (paths)
	`set_strategy` (strategy)
	`set_target_directory` (directory)
	`set_their_label` (label)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_notify` (why, path, baseline, target, workdir)
	`do_progress` (path, completed_steps, total_steps)

Properties¶

Name	Type	Flags	Short Description
`ancestor-label`	`str`	r/w	Ancestor label
`baseline`	`Ggit.Tree`	r/w	Baseline
`dir-mode`	`int`	r/w	Dir mode
`disable-filters`	`bool`	r/w	Disable filters
`file-mode`	`int`	r/w	File mode
`file-open-flags`	`int`	r/w	File open flags
`notify-flags`	`Ggit.CheckoutNotifyFlags`	r/w	Notify flags
`our-label`	`str`	r/w	Our label
`strategy`	`Ggit.CheckoutStrategy`	r/w	Strategy
`target-directory`	`str`	r/w	Target directory
`their-label`	`str`	r/w	Their label

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Ggit.CheckoutOptions(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Ggit.CheckoutOptionsClass

Represents the options used when doign a checkout.

classmethod new()¶

Returns:: a Ggit.CheckoutOptions or None.
Return type:: Ggit.CheckoutOptions or None

Create a new checkout options object.

get_ancestor_label()¶

Returns:: the checkout ancestor label or None.
Return type:: str or None

Get the checkout ancestor label.

get_baseline()¶

Returns:: a Ggit.Tree or None.
Return type:: Ggit.Tree or None

Get the baseline, i.e. the expected content of workdir. Defaults to HEAD.

get_dir_mode()¶

Returns:: the default directory mode.
Return type:: int

Get the default checkout directory mode.

get_disable_filters()¶

Returns:: True if filters are disabled, False otherwise.
Return type:: bool

Get whether filters are disabled.

get_file_mode()¶

Returns:: the default checkout file mode.
Return type:: int

Get the default checkout file mode.

get_file_open_flags()¶

Returns:: the checkout file open flags.
Return type:: int

Get the checkout file open flags. These flags are platform specific, e.g. on Unix these would include O_CREAT, O_TRUNC, etc.

get_notify_flags()¶

Returns:: a Ggit.CheckoutNotifyFlags.
Return type:: Ggit.CheckoutNotifyFlags

Get the checkout notify flags.

get_our_label()¶

Returns:: the checkout our label or None.
Return type:: str or None

Get the checkout our label.

get_paths()¶

Returns:: a None terminated list of file paths, or None.
Return type:: [str] or None

Get the list of file paths to checkout.

get_strategy()¶

Returns:: a Ggit.CheckoutStrategy.
Return type:: Ggit.CheckoutStrategy

Get the checkout strategy.

get_target_directory()¶

Returns:: the checkout target directory or None.
Return type:: str or None

Get the checkout target directory.

get_their_label()¶

Returns:: the checkout their label or None.
Return type:: str or None

Get the checkout their label.

set_ancestor_label(label)¶

Parameters:: label (str or None) – the ancestor label.

Set the checkout ancestor label.

set_baseline(tree)¶

Parameters:: tree (Ggit.Tree or None) – a Ggit.Tree.

Set the baseline, i.e. the expected content of workdir. If tree is set to None, the default (HEAD) will be used as the baseline.

set_dir_mode(dir_mode)¶

Parameters:: dir_mode (int) – the dir mode.

Set the default checkout directory mode.

set_disable_filters(disable)¶

Parameters:: disable (bool) – disable filters.

Set whether to disable filters.

set_file_mode(file_mode)¶

Parameters:: file_mode (int) – the file mode.

Set the default checkout file mode.

set_file_open_flags(flags)¶

Parameters:: flags (int) – the file open flags.

Set the checkout file open flags. These flags are platform dependent, e.g. on Unix use O_CREAT, O_TRUNC, etc.

set_notify_flags(flags)¶

Parameters:: flags (Ggit.CheckoutNotifyFlags) – a Ggit.CheckoutNotifyFlags.

Set the checkout notify flags.

set_our_label(label)¶

Parameters:: label (str or None) – the our label.

Set the checkout our label.

set_paths(paths)¶

Parameters:: paths ([str] or None) – a None terminated list of paths.

Set the list of file paths to checkout. If paths is None, then all files will be checked out.

set_strategy(strategy)¶

Parameters:: strategy (Ggit.CheckoutStrategy) – a Ggit.CheckoutStrategy.

Set the checkout strategy.

set_target_directory(directory)¶

Parameters:: directory (str or None) – the target directory.

Set the checkout target directory.

set_their_label(label)¶

Parameters:: label (str or None) – the their label.

Set the checkout their label.

do_notify(why, path, baseline, target, workdir) virtual¶

Parameters:

why (Ggit.CheckoutNotifyFlags) –
path (str) –
baseline (Ggit.DiffFile) –
target (Ggit.DiffFile) –
workdir (Ggit.DiffFile) –

Return type:

int

do_progress(path, completed_steps, total_steps) virtual¶

Parameters:

path (str) –
completed_steps (int) –
total_steps (int) –

Property Details¶

Ggit.CheckoutOptions.props.ancestor_label¶

Name:: ancestor-label
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Ancestor label

Ggit.CheckoutOptions.props.baseline¶

Name:: baseline
Type:: Ggit.Tree
Default Value:: None
Flags:: READABLE, WRITABLE

Baseline

Ggit.CheckoutOptions.props.dir_mode¶

Name:: dir-mode
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Dir mode

Ggit.CheckoutOptions.props.disable_filters¶

Name:: disable-filters
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Disable filters

Ggit.CheckoutOptions.props.file_mode¶

Name:: file-mode
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

File mode

Ggit.CheckoutOptions.props.file_open_flags¶

Name:: file-open-flags
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

File open flags

Ggit.CheckoutOptions.props.notify_flags¶

Name:: notify-flags
Type:: Ggit.CheckoutNotifyFlags
Default Value:: Ggit.CheckoutNotifyFlags.NONE
Flags:: READABLE, WRITABLE

The checkout notify flags.

Ggit.CheckoutOptions.props.our_label¶

Name:: our-label
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Our label

Ggit.CheckoutOptions.props.strategy¶

Name:: strategy
Type:: Ggit.CheckoutStrategy
Default Value:: Ggit.CheckoutStrategy.SAFE
Flags:: READABLE, WRITABLE

Strategy

Ggit.CheckoutOptions.props.target_directory¶

Name:: target-directory
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Target directory

Ggit.CheckoutOptions.props.their_label¶

Name:: their-label
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Their label