Gjsify LogoGjsify Logo

Opaque structure, which represents a bad (list) of #ICalProperty objects. Use the functions below to work with it.

record

Hierarchy

  • ComponentPropertyBag

Index

Constructors

Properties

name: string

Methods

  • clear(): void
  • Removes all properties from the bag, thus it doesn't contain any property after this function returns.

    Returns void

  • Adds all the stored properties in the bag to the component. The function doesn't verify whether the component contains the same property already.

    Parameters

    Returns void

  • Returns the #ICalProperty at the given index. If the index is out of bounds (not lower than e_cal_component_property_bag_get_count()), then %NULL is returned.

    The returned property is owned by the bag and should not be freed by the caller.

    Parameters

    • index: number

      an index of the property to get

    Returns ICalGLib.Property

  • get_count(): number
  • remove(index: number): void
  • Removes the #ICalProperty at the given index. If the index is out of bounds (not lower than e_cal_component_property_bag_get_count()), then the function does nothing.

    Parameters

    • index: number

      an index of the property to remove

    Returns void

  • Removes the first or all (depending on the all) properties of the given kind.

    Parameters

    • kind: PropertyKind

      an #ICalPropertyKind to remove

    • all: boolean

      %TRUE to remove all properties of the kind, or %FALSE to only the first

    Returns number

  • Fills the bag with properties from the component, for which the func returned %TRUE. When the func is %NULL, all the properties are included. The bag content is cleared before any property is added.

    Parameters

    • component: ICalGLib.Component

      an #ICalComponent containing the properties to fill the bag with

    Returns void

  • Creates a new #ECalComponentPropertyBag, filled with properties from the component, for which the func returned %TRUE. When the func is %NULL, all the properties are included.

    Free the structure with e_cal_component_property_bag_free(), when no longer needed.

    Parameters

    • component: ICalGLib.Component

      an #ICalComponent containing the properties to fill the bag with

    Returns ComponentPropertyBag

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method