GI.Gtk.Objects.BuilderListItemFactory

GtkBuilderListItemFactory is a GtkListItemFactory that creates widgets by instantiating GtkBuilder UI templates.

The templates must extend the class that the parent widget expects. For example, a factory provided to ListView:factory must have a template that extends ListItem.

Templates typically use GtkExpressions to obtain data from the items in the model.

Example:

xml code

 <interface>
   <template class="GtkListItem">
     <property name="child">
       <object class="GtkLabel">
         <property name="xalign">0</property>
         <binding name="label">
           <lookup name="name" type="SettingsKey">
             <lookup name="item">GtkListItem</lookup>
           </lookup>
         </binding>
       </object>
     </property>
   </template>
 </interface>

Exported types

newtype BuilderListItemFactory

Memory-managed wrapper type.

Constructors

BuilderListItemFactory (ManagedPtr BuilderListItemFactory)

Instances

Eq BuilderListItemFactory

Defined in GI.Gtk.Objects.BuilderListItemFactory

Methods

(==) :: BuilderListItemFactory -> BuilderListItemFactory -> Bool

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

GObject BuilderListItemFactory

Defined in GI.Gtk.Objects.BuilderListItemFactory

ManagedPtrNewtype BuilderListItemFactory

Defined in GI.Gtk.Objects.BuilderListItemFactory

Methods

toManagedPtr :: BuilderListItemFactory -> ManagedPtr BuilderListItemFactory

TypedObject BuilderListItemFactory

Defined in GI.Gtk.Objects.BuilderListItemFactory

Methods

glibType :: IO GType

HasParentTypes BuilderListItemFactory

Defined in GI.Gtk.Objects.BuilderListItemFactory

IsGValue (Maybe BuilderListItemFactory)

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

Defined in GI.Gtk.Objects.BuilderListItemFactory

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes BuilderListItemFactory

Defined in GI.Gtk.Objects.BuilderListItemFactory

type ParentTypes BuilderListItemFactory = '[ListItemFactory, Object]

class (GObject o, IsDescendantOf BuilderListItemFactory o) => IsBuilderListItemFactory o

Type class for types which can be safely cast to BuilderListItemFactory, for instance with toBuilderListItemFactory.

Instances

(GObject o, IsDescendantOf BuilderListItemFactory o) => IsBuilderListItemFactory o

Defined in GI.Gtk.Objects.BuilderListItemFactory

toBuilderListItemFactory :: (MonadIO m, IsBuilderListItemFactory o) => o -> m BuilderListItemFactory

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

getBytes, getData, getProperty, getQdata, getResource, getScope.

Setters

setData, setDataFull, setProperty.

getBytes

builderListItemFactoryGetBytes

Arguments

:: (HasCallStack, MonadIO m, IsBuilderListItemFactory a)

=> a

self: a GtkBuilderListItemFactory

-> m Bytes

Returns: The GtkBuilder data

Gets the data used as the GtkBuilder UI template for constructing listitems.

getResource

builderListItemFactoryGetResource

Arguments

:: (HasCallStack, MonadIO m, IsBuilderListItemFactory a)

=> a

self: a GtkBuilderListItemFactory

-> m (Maybe Text)

Returns: The path to the resource

If the data references a resource, gets the path of that resource.

getScope

builderListItemFactoryGetScope

Arguments

:: (HasCallStack, MonadIO m, IsBuilderListItemFactory a)

=> a

self: a GtkBuilderListItemFactory

-> m (Maybe BuilderScope)

Returns: The scope used when constructing listitems

Gets the scope used when constructing listitems.

newFromBytes

builderListItemFactoryNewFromBytes

Arguments

:: (HasCallStack, MonadIO m, IsBuilderScope a)

=> Maybe a

scope: A scope to use when instantiating

-> Bytes

bytes: the GBytes containing the ui file to instantiate

-> m BuilderListItemFactory

Returns: a new GtkBuilderListItemFactory

Creates a new GtkBuilderListItemFactory that instantiates widgets using bytes as the data to pass to GtkBuilder.

newFromResource

builderListItemFactoryNewFromResource

Arguments

:: (HasCallStack, MonadIO m, IsBuilderScope a)

=> Maybe a

scope: A scope to use when instantiating

-> Text

resourcePath: valid path to a resource that contains the data

-> m BuilderListItemFactory

Returns: a new GtkBuilderListItemFactory

Creates a new GtkBuilderListItemFactory that instantiates widgets using data read from the given resourcePath to pass to GtkBuilder.

Properties

bytes

GBytes containing the UI definition.

constructBuilderListItemFactoryBytes :: (IsBuilderListItemFactory o, MonadIO m) => Bytes -> m (GValueConstruct o)

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

getBuilderListItemFactoryBytes :: (MonadIO m, IsBuilderListItemFactory o) => o -> m Bytes

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

get builderListItemFactory #bytes

resource

Path of the resource containing the UI definition.

constructBuilderListItemFactoryResource :: (IsBuilderListItemFactory o, MonadIO m) => Text -> m (GValueConstruct o)

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

getBuilderListItemFactoryResource :: (MonadIO m, IsBuilderListItemFactory o) => o -> m (Maybe Text)

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

get builderListItemFactory #resource

scope

GtkBuilderScope to use when instantiating listitems

constructBuilderListItemFactoryScope :: (IsBuilderListItemFactory o, MonadIO m, IsBuilderScope a) => a -> m (GValueConstruct o)

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

getBuilderListItemFactoryScope :: (MonadIO m, IsBuilderListItemFactory o) => o -> m (Maybe BuilderScope)

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

get builderListItemFactory #scope