GI.GIRepository.Structs.BaseInfo

GIBaseInfo is the common base struct of all other *Info structs accessible through the Repository API. All other structs can be casted to a BaseInfo, for instance: <example> <title>Casting a GIFunctionInfo to BaseInfo</title> <programlisting> GIFunctionInfo *function_info = ...; GIBaseInfo *info = (GIBaseInfo*)function_info; </programlisting> </example> Most Repository APIs returning a BaseInfo is actually creating a new struct, in other words, g_base_info_unref() has to be called when done accessing the data. GIBaseInfos are normally accessed by calling either repositoryFindByName, repositoryFindByGtype or repositoryGetInfo.

<example> <title>Getting the Button of the Gtk typelib</title> <programlisting> GIBaseInfo *button_info = g_irepository_find_by_name(NULL, "Gtk", "Button"); ... use button_info ... g_base_info_unref(button_info); </programlisting> </example>

<refsect1 id="gi-gibaseinfo.struct-hierarchy" role="struct_hierarchy"> <title role="struct_hierarchy.title">Struct hierarchy</title> <synopsis> GIBaseInfo +----<link linkend="gi-GIArgInfo">GIArgInfo</link> +----<link linkend="gi-GICallableInfo">GICallableInfo</link> +----<link linkend="gi-GIConstantInfo">GIConstantInfo</link> +----<link linkend="gi-GIFieldInfo">GIFieldInfo</link> +----<link linkend="gi-GIPropertyInfo">GIPropertyInfo</link> +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link> +----<link linkend="gi-GITypeInfo">GITypeInfo</link> </synopsis> </refsect1>

Exported types

newtype BaseInfo

Memory-managed wrapper type.

Constructors

BaseInfo (ManagedPtr BaseInfo)

Instances

Eq BaseInfo

Defined in GI.GIRepository.Structs.BaseInfo

Methods

(==) :: BaseInfo -> BaseInfo -> Bool

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

GBoxed BaseInfo

Defined in GI.GIRepository.Structs.BaseInfo

ManagedPtrNewtype BaseInfo

Defined in GI.GIRepository.Structs.BaseInfo

Methods

toManagedPtr :: BaseInfo -> ManagedPtr BaseInfo

TypedObject BaseInfo

Defined in GI.GIRepository.Structs.BaseInfo

Methods

glibType :: IO GType

HasParentTypes BaseInfo

Defined in GI.GIRepository.Structs.BaseInfo

tag ~ 'AttrSet => Constructible BaseInfo tag

Defined in GI.GIRepository.Structs.BaseInfo

Methods

new :: MonadIO m => (ManagedPtr BaseInfo -> BaseInfo) -> [AttrOp BaseInfo tag] -> m BaseInfo

IsGValue (Maybe BaseInfo)

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

Defined in GI.GIRepository.Structs.BaseInfo

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes BaseInfo

Defined in GI.GIRepository.Structs.BaseInfo

type ParentTypes BaseInfo = '[] :: [Type]

newZeroBaseInfo :: MonadIO m => m BaseInfo

Construct a BaseInfo struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

equal, isDeprecated, iterateAttributes.

Getters

getAttribute, getContainer, getName, getNamespace, getType, getTypelib.

Setters

None.

equal

baseInfoEqual

Arguments

:: (HasCallStack, MonadIO m)

=> BaseInfo

info1: a BaseInfo

-> BaseInfo

info2: a BaseInfo

-> m Bool

Returns: True if and only if info1 equals info2.

Compare two BaseInfo.

Using pointer comparison is not practical since many functions return different instances of BaseInfo that refers to the same part of the TypeLib; use this function instead to do BaseInfo comparisons.

getAttribute

baseInfoGetAttribute

Arguments

:: (HasCallStack, MonadIO m)

=> BaseInfo

info: a BaseInfo

-> Text

name: a freeform string naming an attribute

-> m Text

Returns: The value of the attribute, or Nothing if no such attribute exists

Retrieve an arbitrary attribute associated with this node.

getContainer

baseInfoGetContainer

Arguments

:: (HasCallStack, MonadIO m)

=> BaseInfo

info: a BaseInfo

-> m BaseInfo

Returns: the container

Obtain the container of the info. The container is the parent GIBaseInfo. For instance, the parent of a GIFunctionInfo is an GIObjectInfo or GIInterfaceInfo.

getName

baseInfoGetName

Arguments

:: (HasCallStack, MonadIO m)

=> BaseInfo

info: a BaseInfo

-> m Text

Returns: the name of info or Nothing if it lacks a name.

Obtain the name of the info. What the name represents depends on the InfoType of the info. For instance for GIFunctionInfo it is the name of the function.

getNamespace

baseInfoGetNamespace

Arguments

:: (HasCallStack, MonadIO m)

=> BaseInfo

info: a BaseInfo

-> m Text

Returns: the namespace

Obtain the namespace of info.

getType

baseInfoGetType

Arguments

:: (HasCallStack, MonadIO m)

=> BaseInfo

info: a BaseInfo

-> m InfoType

Returns: the info type of info

Obtain the info type of the GIBaseInfo.

getTypelib

baseInfoGetTypelib

Arguments

:: (HasCallStack, MonadIO m)

=> BaseInfo

info: a BaseInfo

-> m Typelib

Returns: the typelib.

Obtain the typelib this info belongs to

isDeprecated

baseInfoIsDeprecated

Arguments

:: (HasCallStack, MonadIO m)

=> BaseInfo

info: a BaseInfo

-> m Bool

Returns: True if deprecated

Obtain whether the info is represents a metadata which is deprecated or not.

iterateAttributes

baseInfoIterateAttributes

Arguments

:: (HasCallStack, MonadIO m)

=> BaseInfo

info: a BaseInfo

-> AttributeIter

iterator: a AttributeIter structure, must be initialized; see below

-> m (Bool, Text, Text)

Returns: True if there are more attributes

Iterate over all attributes associated with this node. The iterator structure is typically stack allocated, and must have its first member initialized to Nothing. Attributes are arbitrary namespaced key–value pairs which can be attached to almost any item. They are intended for use by software higher in the toolchain than bindings, and are distinct from normal GIR annotations.

Both the name and value should be treated as constants and must not be freed.

<example> <title>Iterating over attributes</title> <programlisting> void print_attributes (GIBaseInfo *info) { GIAttributeIter iter = { 0, }; char *name; char *value; while (g_base_info_iterate_attributes (info, &iter, &name, &value)) { g_print ("attribute name: s value: s", name, value); } } </programlisting> </example>