GI.Dazzle.Objects.PathElement

No description available in the introspection data.

Exported types

newtype PathElement

Memory-managed wrapper type.

Constructors

PathElement (ManagedPtr PathElement)

Instances

Eq PathElement

Defined in GI.Dazzle.Objects.PathElement

Methods

(==) :: PathElement -> PathElement -> Bool

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

GObject PathElement

Defined in GI.Dazzle.Objects.PathElement

ManagedPtrNewtype PathElement

Defined in GI.Dazzle.Objects.PathElement

Methods

toManagedPtr :: PathElement -> ManagedPtr PathElement

TypedObject PathElement

Defined in GI.Dazzle.Objects.PathElement

Methods

glibType :: IO GType

HasParentTypes PathElement

Defined in GI.Dazzle.Objects.PathElement

IsGValue (Maybe PathElement)

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

Defined in GI.Dazzle.Objects.PathElement

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes PathElement

Defined in GI.Dazzle.Objects.PathElement

type ParentTypes PathElement = '[Object]

class (GObject o, IsDescendantOf PathElement o) => IsPathElement o

Type class for types which can be safely cast to PathElement, for instance with toPathElement.

Instances

(GObject o, IsDescendantOf PathElement o) => IsPathElement o

Defined in GI.Dazzle.Objects.PathElement

toPathElement :: (MonadIO m, IsPathElement o) => o -> m PathElement

Cast to PathElement, 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

getData, getIconName, getId, getProperty, getQdata, getTitle.

Setters

setData, setDataFull, setProperty.

getIconName

pathElementGetIconName

Arguments

:: (HasCallStack, MonadIO m, IsPathElement a)

=> a

self: A PathElement

-> m (Maybe Text)

Returns: The icon-name for the PathElement.

Gets the PathElement:iconName property. This is used by the path bar to display an icon next to the element of the path.

Since: 3.26

getId

pathElementGetId

Arguments

:: (HasCallStack, MonadIO m, IsPathElement a)

=> a

self: A PathElement

-> m Text

Returns: The id for the PathElement.

Gets the id for the element. Generally, a path is built of multiple elements and each element should have an id that is useful to the application that it using it. You might store the name of a directory, or some other key as the id.

Since: 3.26

getTitle

pathElementGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsPathElement a)

=> a

self: A PathElement

-> m (Maybe Text)

Returns: The title for the PathElement.

Gets the PathElement:title property. This is used by the path bar to display text representing the element of the path.

Since: 3.26

new

pathElementNew

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

id: An id for the path element.

-> Maybe Text

iconName: An optional icon name for the element

-> Text

title: The title of the element.

-> m PathElement

Returns: A PathElement

Creates a new path element for an Path.

Since: 3.26

Properties

iconName

The icon-name of the icon to display next to the path element in the path bar. Set to Nothing for no icon.

Since: 3.26

constructPathElementIconName :: (IsPathElement o, MonadIO m) => Text -> m (GValueConstruct o)

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

getPathElementIconName :: (MonadIO m, IsPathElement o) => o -> m (Maybe Text)

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

get pathElement #iconName

id

The id property is an application specific identifier for the element within the path.

Since: 3.26

constructPathElementId :: (IsPathElement o, MonadIO m) => Text -> m (GValueConstruct o)

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

getPathElementId :: (MonadIO m, IsPathElement o) => o -> m Text

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

get pathElement #id

title

The title property should contain the display text that should be shown to represent the element in the PathBar.

Since: 3.26

constructPathElementTitle :: (IsPathElement o, MonadIO m) => Text -> m (GValueConstruct o)

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

getPathElementTitle :: (MonadIO m, IsPathElement o) => o -> m (Maybe Text)

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

get pathElement #title