Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

g_type_instance: TypeInstance
object: GObject.Object
name: string

Methods

  • abort_sequence(): void
  • Aborts the sequence change needed in the given calendar component, which means it will not require a sequence commit (via #e_cal_component_commit_sequence) even if the changes done require a sequence increment.

    Returns void

  • Adds an alarm subcomponent to a calendar component. You should have created the alarm by using e_cal_component_alarm_new(); it is invalid to use a #ECalComponentAlarm structure that came from e_cal_component_get_alarm(). After adding the alarm, the alarm structure is no longer valid because the internal structures may change and you should get rid of it by using e_cal_component_alarm_free().

    Parameters

    Returns void

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transform_from: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • commit_sequence(): void
  • Increments the sequence number property in a calendar component object if it needs it. This needs to be done when any of a number of properties listed in RFC 2445 change values, such as the start and end dates of a component.

    This function must be called before calling e_cal_component_get_as_string() to ensure that the component is fully consistent.

    Returns void

  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • disconnect(id: number): void
  • emit(sigName: string, ...args: any[]): void
  • Checks if the DTSTART and DTEND properties of the 2 components match. Note that the events may have different recurrence properties which are not taken into account here.

    Parameters

    Returns boolean

  • force_floating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freeze_notify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • get_alarm_uids(): string[]
  • get_as_string(): string
  • Gets the iCalendar string representation of a calendar component. You should call e_cal_component_commit_sequence() before this function to ensure that the component's sequence number is consistent with the state of the object.

    Returns string

  • get_attachment_list(): string[]
  • Queries the attachment properties of the calendar component object. When done, the attachment_list should be freed by calling g_slist_free().

    Returns string[]

  • get_categories(categories: string): void
  • Queries the categories of the given calendar component. The categories are returned in the categories argument, which, on success, will contain a comma-separated list of all categories set in the component.

    Parameters

    • categories: string

      Return holder for the categories.

    Returns void

  • get_categories_list(): string[]
  • Queries the list of categories of a calendar component object. Each element in the returned categ_list is a string with the corresponding category.

    Returns string[]

  • Queries the classification of a calendar component object. If the classification property is not set on this component, this function returns #E_CAL_COMPONENT_CLASS_NONE.

    Parameters

    Returns void

  • get_completed(t: object): void
  • Queries the date at which a calendar compoment object was completed.

    Parameters

    • t: object

      Return value for the completion date. This should be freed using the e_cal_component_free_icaltimetype() function.

    Returns void

  • get_created(t: object): void
  • Queries the date in which a calendar component object was created in the calendar store.

    Parameters

    • t: object

      Return value for the creation date. This should be freed using the e_cal_component_free_icaltimetype() function.

    Returns void

  • get_data(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • Queries the description of a calendar component object. Journal components may have more than one description, and as such this function returns a list of #ECalComponentText structures. All other types of components can have at most one description.

    Returns CalComponentText[]

  • get_dtstamp(t: object): void
  • Queries the date/timestamp property of a calendar component object, which is the last time at which the object was modified by a calendar user agent.

    Parameters

    • t: object

      A value for the date/timestamp.

    Returns void

  • get_geo(geo: object): void
  • Gets the geographic position property of a calendar component object.

    Parameters

    • geo: object

      Return value for the geographic position property. This should be freed using the e_cal_component_free_geo() function.

    Returns void

  • get_last_modified(t: object): void
  • Queries the time at which a calendar component object was last modified in the calendar store.

    Parameters

    • t: object

      Return value for the last modified time value.

    Returns void

  • get_location(location: string): void
  • Queries the location property of a calendar component object.

    Parameters

    • location: string

      Return value for the location.

    Returns void

  • get_num_attachments(): number
  • get_percent(percent: number): void
  • Queries the percent-complete property of a calendar component object.

    Parameters

    • percent: number

      Return value for the percent-complete property. This should be freed using the e_cal_component_free_percent() function.

    Returns void

  • get_percent_as_int(): number
  • get_priority(priority: number): void
  • Queries the priority property of a calendar component object.

    Parameters

    • priority: number

      Return value for the priority property. This should be freed using the e_cal_component_free_priority() function.

    Returns void

  • get_property(property_name?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • get_recurid_as_string(): string
  • get_sequence(sequence: number): void
  • Queries the sequence number of a calendar component object.

    Parameters

    • sequence: number

      Return value for the sequence number. This should be freed using e_cal_component_free_sequence().

    Returns void

  • get_uid(uid: string): void
  • Queries the unique identifier of a calendar component object.

    Parameters

    • uid: string

      Return value for the UID string.

    Returns void

  • get_url(url: string): void
  • Queries the uniform resource locator property of a calendar component object.

    Parameters

    • url: string

      Return value for the URL.

    Returns void

  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • has_alarms(): boolean
  • has_attachments(): boolean
  • has_attendees(): boolean
  • has_exceptions(): boolean
  • has_exdates(): boolean
  • has_exrules(): boolean
  • has_organizer(): boolean
  • has_rdates(): boolean
  • has_recurrences(): boolean
  • has_rrules(): boolean
  • has_simple_recurrence(): boolean
  • is_floating(): boolean
  • is_instance(): boolean
  • notify(property_name: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • remove_alarm(auid: string): void
  • Removes an alarm subcomponent from a calendar component. If the alarm that corresponds to the specified auid had been fetched with e_cal_component_get_alarm(), then those alarm structures will be invalid; you should get rid of them with e_cal_component_alarm_free() before using this function.

    Parameters

    • auid: string

      UID of the alarm to remove.

    Returns void

  • remove_all_alarms(): void
  • rescan(): void
  • Rescans the #icalcomponent being wrapped by the given calendar component. This would replace any value that was changed in the wrapped #icalcomponent.

    Returns void

  • run_dispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • set_attachment_list(attachment_list: string[]): void
  • This currently handles only attachments that are URIs in the file system - not inline binaries.

    Sets the attachments of a calendar component object

    Parameters

    • attachment_list: string[]

      list of URIs to attachment pointers

    Returns void

  • set_categories(categories: string): void
  • Sets the list of categories for a calendar component.

    Parameters

    • categories: string

      Comma-separated list of categories.

    Returns void

  • set_categories_list(categ_list: string[]): void
  • Sets the list of categories of a calendar component object.

    Parameters

    • categ_list: string[]

      List of strings, one for each category.

    Returns void

  • Sets the comments of a calendar component object. The comment property can appear several times inside a calendar component, and so a list of #ECalComponentText structures is used.

    Parameters

    Returns void

  • set_completed(t: object): void
  • Sets the date at which a calendar component object was completed.

    Parameters

    • t: object

      Value for the completion date.

    Returns void

  • Sets the contact of a calendar component object. The contact property can appear several times inside a calendar component, and so a list of #ECalComponentText structures is used.

    Parameters

    Returns void

  • set_created(t: object): void
  • Sets the date in which a calendar component object is created in the calendar store. This should only be used inside a calendar store application, i.e. not by calendar user agents.

    Parameters

    • t: object

      Value for the creation date.

    Returns void

  • set_data(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • set_dtstamp(t: object): void
  • Sets the date/timestamp of a calendar component object. This should be called whenever a calendar user agent makes a change to a component's properties.

    Parameters

    • t: object

      Date/timestamp value.

    Returns void

  • set_geo(geo: object): void
  • Sets the geographic position property on a calendar component object.

    Parameters

    • geo: object

      Value for the geographic position property.

    Returns void

  • set_icalcomponent(icalcomp: number): boolean
  • Sets the contents of a calendar component object from an #icalcomponent structure. If the comp already had an #icalcomponent set into it, it will will be freed automatically if the #icalcomponent does not have a parent component itself.

    Supported component types are VEVENT, VTODO, VJOURNAL, VFREEBUSY, and VTIMEZONE.

    Parameters

    • icalcomp: number

      An #icalcomponent.

    Returns boolean

  • set_last_modified(t: object): void
  • Sets the time at which a calendar component object was last stored in the calendar store. This should not be called by plain calendar user agents.

    Parameters

    • t: object

      Value for the last time modified.

    Returns void

  • set_location(location: string): void
  • Clears any existing component data from a calendar component object and creates a new #icalcomponent of the specified type for it. The only property that will be set in the new component will be its unique identifier.

    Parameters

    Returns void

  • set_percent(percent: number): void
  • Sets the percent-complete property of a calendar component object.

    Parameters

    • percent: number

      Value for the percent-complete property.

    Returns void

  • set_percent_as_int(percent: number): void
  • set_priority(priority: number): void
  • Sets the priority property of a calendar component object.

    Parameters

    • priority: number

      Value for the priority property.

    Returns void

  • set_property(property_name: string, value?: any): void
  • set_sequence(sequence: number): void
  • Sets the sequence number of a calendar component object. Normally this function should not be called, since the sequence number is incremented automatically at the proper times.

    Parameters

    • sequence: number

      Sequence number value.

    Returns void

  • set_uid(uid: string): void
  • set_url(url: string): void
  • steal_data(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • steal_qdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • strip_errors(): void
  • Strips all error messages from the calendar component. Those error messages are added to the iCalendar string representation whenever an invalid is used for one of its fields.

    Returns void

  • thaw_notify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    virtual

    Parameters

    Returns void

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • watch_closure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compat_control(what: number, data: object): number
  • free_categories_list(categ_list: string[]): void
  • free_geo(geo: object): void
  • Frees a struct #icalgeotype structure as returned by the calendar component functions.

    Parameters

    • geo: object

      An #icalgeotype structure.

    Returns void

  • free_icaltimetype(t: object): void
  • Frees a struct #icaltimetype value as returned by the calendar component functions.

    Parameters

    • t: object

      An #icaltimetype structure.

    Returns void

  • free_percent(percent: number): void
  • Frees a percent value as returned by the e_cal_component_get_percent() function.

    Parameters

    • percent: number

      Percent value.

    Returns void

  • free_priority(priority: number): void
  • Frees a priority value as returned by the e_cal_component_get_priority() function.

    Parameters

    • priority: number

      Priority value.

    Returns void

  • free_sequence(sequence: number): void
  • Frees a list of #ECalComponentText structures. This function should only be used to free lists of text values as returned by the other getter functions of #ECalComponent.

    Parameters

    Returns void

  • gen_uid(): string
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • property_name: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new empty calendar component object. Once created, you should set it from an existing #icalcomponent structure by using e_cal_component_set_icalcomponent() or with a new empty component type by using e_cal_component_set_new_vtype().

    Returns CalComponent

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • object_type: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

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