GI.Ggit.Objects.CheckoutOptions

Represents the options used when doign a checkout.

Exported types

newtype CheckoutOptions

Memory-managed wrapper type.

Constructors

CheckoutOptions (ManagedPtr CheckoutOptions)

Instances

Eq CheckoutOptions

Defined in GI.Ggit.Objects.CheckoutOptions

Methods

(==) :: CheckoutOptions -> CheckoutOptions -> Bool

(/=) :: CheckoutOptions -> CheckoutOptions -> Bool

GObject CheckoutOptions

Defined in GI.Ggit.Objects.CheckoutOptions

ManagedPtrNewtype CheckoutOptions

Defined in GI.Ggit.Objects.CheckoutOptions

Methods

toManagedPtr :: CheckoutOptions -> ManagedPtr CheckoutOptions

TypedObject CheckoutOptions

Defined in GI.Ggit.Objects.CheckoutOptions

Methods

glibType :: IO GType

HasParentTypes CheckoutOptions

Defined in GI.Ggit.Objects.CheckoutOptions

IsGValue (Maybe CheckoutOptions)

Convert CheckoutOptions to and from GValue. See toGValue and fromGValue.

Defined in GI.Ggit.Objects.CheckoutOptions

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe CheckoutOptions -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe CheckoutOptions)

type ParentTypes CheckoutOptions

Defined in GI.Ggit.Objects.CheckoutOptions

type ParentTypes CheckoutOptions = '[Object]

class (GObject o, IsDescendantOf CheckoutOptions o) => IsCheckoutOptions o

Type class for types which can be safely cast to CheckoutOptions, for instance with toCheckoutOptions.

Instances

(GObject o, IsDescendantOf CheckoutOptions o) => IsCheckoutOptions o

Defined in GI.Ggit.Objects.CheckoutOptions

toCheckoutOptions :: (MonadIO m, IsCheckoutOptions o) => o -> m CheckoutOptions

Cast to CheckoutOptions, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAncestorLabel, getBaseline, getData, getDirMode, getDisableFilters, getFileMode, getFileOpenFlags, getNotifyFlags, getOurLabel, getPaths, getProperty, getQdata, getStrategy, getTargetDirectory, getTheirLabel.

Setters

setAncestorLabel, setBaseline, setData, setDataFull, setDirMode, setDisableFilters, setFileMode, setFileOpenFlags, setNotifyFlags, setOurLabel, setPaths, setProperty, setStrategy, setTargetDirectory, setTheirLabel.

getAncestorLabel

checkoutOptionsGetAncestorLabel

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m (Maybe Text)

Returns: the checkout ancestor label or Nothing.

Get the checkout ancestor label.

getBaseline

checkoutOptionsGetBaseline

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m (Maybe Tree)

Returns: a Tree or Nothing.

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

getDirMode

checkoutOptionsGetDirMode

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m Word32

Returns: the default directory mode.

Get the default checkout directory mode.

getDisableFilters

checkoutOptionsGetDisableFilters

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m Bool

Returns: True if filters are disabled, False otherwise.

Get whether filters are disabled.

getFileMode

checkoutOptionsGetFileMode

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m Word32

Returns: the default checkout file mode.

Get the default checkout file mode.

getFileOpenFlags

checkoutOptionsGetFileOpenFlags

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m Int32

Returns: the checkout file open flags.

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

getNotifyFlags

checkoutOptionsGetNotifyFlags

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m [CheckoutNotifyFlags]

Returns: a CheckoutNotifyFlags.

Get the checkout notify flags.

getOurLabel

checkoutOptionsGetOurLabel

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m (Maybe Text)

Returns: the checkout our label or Nothing.

Get the checkout our label.

getPaths

checkoutOptionsGetPaths

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m (Maybe [Text])

Returns: a Nothing terminated list of file paths, or Nothing.

Get the list of file paths to checkout.

getStrategy

checkoutOptionsGetStrategy

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m [CheckoutStrategy]

Returns: a CheckoutStrategy.

Get the checkout strategy.

getTargetDirectory

checkoutOptionsGetTargetDirectory

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m (Maybe Text)

Returns: the checkout target directory or Nothing.

Get the checkout target directory.

getTheirLabel

checkoutOptionsGetTheirLabel

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m (Maybe Text)

Returns: the checkout their label or Nothing.

Get the checkout their label.

new

checkoutOptionsNew

Arguments

:: (HasCallStack, MonadIO m)

=> m (Maybe CheckoutOptions)

Returns: a CheckoutOptions or Nothing.

Create a new checkout options object.

setAncestorLabel

checkoutOptionsSetAncestorLabel

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Maybe Text

label: the ancestor label.

-> m ()

Set the checkout ancestor label.

setBaseline

checkoutOptionsSetBaseline

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a, IsTree b)

=> a

options: a CheckoutOptions.

-> Maybe b

tree: a Tree.

-> m ()

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

setDirMode

checkoutOptionsSetDirMode

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Word32

dirMode: the dir mode.

-> m ()

Set the default checkout directory mode.

setDisableFilters

checkoutOptionsSetDisableFilters

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Bool

disable: disable filters.

-> m ()

Set whether to disable filters.

setFileMode

checkoutOptionsSetFileMode

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Word32

fileMode: the file mode.

-> m ()

Set the default checkout file mode.

setFileOpenFlags

checkoutOptionsSetFileOpenFlags

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Int32

flags: the file open flags.

-> m ()

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

setNotifyFlags

checkoutOptionsSetNotifyFlags

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> [CheckoutNotifyFlags]

flags: a CheckoutNotifyFlags.

-> m ()

Set the checkout notify flags.

setOurLabel

checkoutOptionsSetOurLabel

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Maybe Text

label: the our label.

-> m ()

Set the checkout our label.

setPaths

checkoutOptionsSetPaths

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Maybe [Text]

paths: a Nothing terminated list of paths.

-> m ()

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

setStrategy

checkoutOptionsSetStrategy

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> [CheckoutStrategy]

strategy: a CheckoutStrategy.

-> m ()

Set the checkout strategy.

setTargetDirectory

checkoutOptionsSetTargetDirectory

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Maybe Text

directory: the target directory.

-> m ()

Set the checkout target directory.

setTheirLabel

checkoutOptionsSetTheirLabel

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Maybe Text

label: the their label.

-> m ()

Set the checkout their label.

Properties

ancestorLabel

No description available in the introspection data.

clearCheckoutOptionsAncestorLabel :: (MonadIO m, IsCheckoutOptions o) => o -> m ()

Set the value of the “ancestor-label” property to Nothing. When overloading is enabled, this is equivalent to

clear #ancestorLabel

constructCheckoutOptionsAncestorLabel :: (IsCheckoutOptions o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “ancestor-label” property. This is rarely needed directly, but it is used by new.

getCheckoutOptionsAncestorLabel :: (MonadIO m, IsCheckoutOptions o) => o -> m (Maybe Text)

Get the value of the “ancestor-label” property. When overloading is enabled, this is equivalent to

get checkoutOptions #ancestorLabel

setCheckoutOptionsAncestorLabel :: (MonadIO m, IsCheckoutOptions o) => o -> Text -> m ()

Set the value of the “ancestor-label” property. When overloading is enabled, this is equivalent to

set checkoutOptions [ #ancestorLabel := value ]

baseline

No description available in the introspection data.

clearCheckoutOptionsBaseline :: (MonadIO m, IsCheckoutOptions o) => o -> m ()

Set the value of the “baseline” property to Nothing. When overloading is enabled, this is equivalent to

clear #baseline

constructCheckoutOptionsBaseline :: (IsCheckoutOptions o, MonadIO m, IsTree a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “baseline” property. This is rarely needed directly, but it is used by new.

getCheckoutOptionsBaseline :: (MonadIO m, IsCheckoutOptions o) => o -> m (Maybe Tree)

Get the value of the “baseline” property. When overloading is enabled, this is equivalent to

get checkoutOptions #baseline

setCheckoutOptionsBaseline :: (MonadIO m, IsCheckoutOptions o, IsTree a) => o -> a -> m ()

Set the value of the “baseline” property. When overloading is enabled, this is equivalent to

set checkoutOptions [ #baseline := value ]

dirMode

No description available in the introspection data.

constructCheckoutOptionsDirMode :: (IsCheckoutOptions o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “dir-mode” property. This is rarely needed directly, but it is used by new.

getCheckoutOptionsDirMode :: (MonadIO m, IsCheckoutOptions o) => o -> m Word32

Get the value of the “dir-mode” property. When overloading is enabled, this is equivalent to

get checkoutOptions #dirMode

setCheckoutOptionsDirMode :: (MonadIO m, IsCheckoutOptions o) => o -> Word32 -> m ()

Set the value of the “dir-mode” property. When overloading is enabled, this is equivalent to

set checkoutOptions [ #dirMode := value ]

disableFilters

No description available in the introspection data.

constructCheckoutOptionsDisableFilters :: (IsCheckoutOptions o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “disable-filters” property. This is rarely needed directly, but it is used by new.

getCheckoutOptionsDisableFilters :: (MonadIO m, IsCheckoutOptions o) => o -> m Bool

Get the value of the “disable-filters” property. When overloading is enabled, this is equivalent to

get checkoutOptions #disableFilters

setCheckoutOptionsDisableFilters :: (MonadIO m, IsCheckoutOptions o) => o -> Bool -> m ()

Set the value of the “disable-filters” property. When overloading is enabled, this is equivalent to

set checkoutOptions [ #disableFilters := value ]

fileMode

No description available in the introspection data.

constructCheckoutOptionsFileMode :: (IsCheckoutOptions o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “file-mode” property. This is rarely needed directly, but it is used by new.

getCheckoutOptionsFileMode :: (MonadIO m, IsCheckoutOptions o) => o -> m Word32

Get the value of the “file-mode” property. When overloading is enabled, this is equivalent to

get checkoutOptions #fileMode

setCheckoutOptionsFileMode :: (MonadIO m, IsCheckoutOptions o) => o -> Word32 -> m ()

Set the value of the “file-mode” property. When overloading is enabled, this is equivalent to

set checkoutOptions [ #fileMode := value ]

fileOpenFlags

No description available in the introspection data.

constructCheckoutOptionsFileOpenFlags :: (IsCheckoutOptions o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “file-open-flags” property. This is rarely needed directly, but it is used by new.

getCheckoutOptionsFileOpenFlags :: (MonadIO m, IsCheckoutOptions o) => o -> m Int32

Get the value of the “file-open-flags” property. When overloading is enabled, this is equivalent to

get checkoutOptions #fileOpenFlags

setCheckoutOptionsFileOpenFlags :: (MonadIO m, IsCheckoutOptions o) => o -> Int32 -> m ()

Set the value of the “file-open-flags” property. When overloading is enabled, this is equivalent to

set checkoutOptions [ #fileOpenFlags := value ]

notifyFlags

The checkout notify flags.

constructCheckoutOptionsNotifyFlags :: (IsCheckoutOptions o, MonadIO m) => [CheckoutNotifyFlags] -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “notify-flags” property. This is rarely needed directly, but it is used by new.

getCheckoutOptionsNotifyFlags :: (MonadIO m, IsCheckoutOptions o) => o -> m [CheckoutNotifyFlags]

Get the value of the “notify-flags” property. When overloading is enabled, this is equivalent to

get checkoutOptions #notifyFlags

setCheckoutOptionsNotifyFlags :: (MonadIO m, IsCheckoutOptions o) => o -> [CheckoutNotifyFlags] -> m ()

Set the value of the “notify-flags” property. When overloading is enabled, this is equivalent to

set checkoutOptions [ #notifyFlags := value ]

ourLabel

No description available in the introspection data.

clearCheckoutOptionsOurLabel :: (MonadIO m, IsCheckoutOptions o) => o -> m ()

Set the value of the “our-label” property to Nothing. When overloading is enabled, this is equivalent to

clear #ourLabel

constructCheckoutOptionsOurLabel :: (IsCheckoutOptions o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “our-label” property. This is rarely needed directly, but it is used by new.

getCheckoutOptionsOurLabel :: (MonadIO m, IsCheckoutOptions o) => o -> m (Maybe Text)

Get the value of the “our-label” property. When overloading is enabled, this is equivalent to

get checkoutOptions #ourLabel

setCheckoutOptionsOurLabel :: (MonadIO m, IsCheckoutOptions o) => o -> Text -> m ()

Set the value of the “our-label” property. When overloading is enabled, this is equivalent to

set checkoutOptions [ #ourLabel := value ]

strategy

No description available in the introspection data.

constructCheckoutOptionsStrategy :: (IsCheckoutOptions o, MonadIO m) => [CheckoutStrategy] -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “strategy” property. This is rarely needed directly, but it is used by new.

getCheckoutOptionsStrategy :: (MonadIO m, IsCheckoutOptions o) => o -> m [CheckoutStrategy]

Get the value of the “strategy” property. When overloading is enabled, this is equivalent to

get checkoutOptions #strategy

setCheckoutOptionsStrategy :: (MonadIO m, IsCheckoutOptions o) => o -> [CheckoutStrategy] -> m ()

Set the value of the “strategy” property. When overloading is enabled, this is equivalent to

set checkoutOptions [ #strategy := value ]

targetDirectory

No description available in the introspection data.

clearCheckoutOptionsTargetDirectory :: (MonadIO m, IsCheckoutOptions o) => o -> m ()

Set the value of the “target-directory” property to Nothing. When overloading is enabled, this is equivalent to

clear #targetDirectory

constructCheckoutOptionsTargetDirectory :: (IsCheckoutOptions o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “target-directory” property. This is rarely needed directly, but it is used by new.

getCheckoutOptionsTargetDirectory :: (MonadIO m, IsCheckoutOptions o) => o -> m (Maybe Text)

Get the value of the “target-directory” property. When overloading is enabled, this is equivalent to

get checkoutOptions #targetDirectory

setCheckoutOptionsTargetDirectory :: (MonadIO m, IsCheckoutOptions o) => o -> Text -> m ()

Set the value of the “target-directory” property. When overloading is enabled, this is equivalent to

set checkoutOptions [ #targetDirectory := value ]

theirLabel

No description available in the introspection data.

clearCheckoutOptionsTheirLabel :: (MonadIO m, IsCheckoutOptions o) => o -> m ()

Set the value of the “their-label” property to Nothing. When overloading is enabled, this is equivalent to

clear #theirLabel

constructCheckoutOptionsTheirLabel :: (IsCheckoutOptions o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “their-label” property. This is rarely needed directly, but it is used by new.

getCheckoutOptionsTheirLabel :: (MonadIO m, IsCheckoutOptions o) => o -> m (Maybe Text)

Get the value of the “their-label” property. When overloading is enabled, this is equivalent to

get checkoutOptions #theirLabel

setCheckoutOptionsTheirLabel :: (MonadIO m, IsCheckoutOptions o) => o -> Text -> m ()

Set the value of the “their-label” property. When overloading is enabled, this is equivalent to

set checkoutOptions [ #theirLabel := value ]