Gjsify LogoGjsify Logo

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

record

Hierarchy

  • ComponentParameterBag

Index

Constructors

Properties

name: string

Methods

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

    Returns void

  • Adds all the stored parameters in the bag to the property. The function replaces any existing parameter with the new value, if any such exists. Otherwise the parameter is added.

    Parameters

    Returns void

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

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

    Parameters

    • index: number

      an index of the parameter to get

    Returns ICalGLib.Parameter

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

    Parameters

    • index: number

      an index of the parameter to remove

    Returns void

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

    Parameters

    • kind: ParameterKind

      an #ICalParameterKind to remove

    • all: boolean

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

    Returns number

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

    Parameters

    • property: ICalGLib.Property

      an #ICalProperty containing the parameters to fill the bag with

    Returns void

  • Creates a new #ECalComponentParameterBag, filled with parameters from the property, for which the func returned %TRUE. When the func is %NULL, all the parameters are included.

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

    Parameters

    • property: ICalGLib.Property

      an #ICalProperty containing the parameters to fill the bag with

    Returns ComponentParameterBag

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