Gjsify LogoGjsify Logo

Contains only private data that should be read and manipulated using the functions below.

Hierarchy

Index

Constructors

Properties

avoid_ifmatch: boolean
calendar_auto_schedule: boolean
color: string
display_name: string
email_address: string
g_type_instance: TypeInstance
order: number
resource_path: string
resource_query: string
soup_uri: Soup.URI
ssl_trust: string
name: string

Methods

  • 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

  • connect(sigName: "notify::avoid-ifmatch", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::calendar-auto-schedule", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::color", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::display-name", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::email-address", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::order", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::resource-path", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::resource-query", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::soup-uri", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::ssl-trust", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::source", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: "notify::avoid-ifmatch", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::calendar-auto-schedule", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::color", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::display-name", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::email-address", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::order", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::resource-path", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::resource-query", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::soup-uri", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::ssl-trust", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::source", callback: (($obj: SourceWebdav, pspec: ParamSpec) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • disconnect(id: number): void
  • dup_color(): string
  • Thread-safe variation of e_source_webdav_get_color(). Use this function when accessing extension from multiple threads.

    The returned string should be freed with g_free() when no longer needed.

    Returns string

  • dup_display_name(): string
  • Thread-safe variation of e_source_webdav_get_display_name(). Use this function when accessing extension from multiple threads.

    The returned string should be freed with g_free() when no longer needed.

    Returns string

  • dup_email_address(): string
  • Thread-safe variation of e_source_webdav_get_email_address(). Use this function when accessing extension from multiple threads.

    The returned string should be freed with g_free() when no longer needed.

    Returns string

  • dup_resource_path(): string
  • Thread-safe variation of e_source_webdav_get_resource_path(). Use this function when accessing extension from multiple threads.

    The returned string should be freed with g_free() when no longer needed.

    Returns string

  • dup_resource_query(): string
  • Thread-safe variation of e_source_webdav_get_resource_query(). Use this function when accessing extension from multiple threads.

    The returned string should be freed with g_free() when no longer needed.

    Returns string

  • This is a convenience function which returns a newly-allocated #SoupURI, its contents assembled from the #ESourceAuthentication extension, the #ESourceSecurity extension, and extension itself. Free the returned #SoupURI with soup_uri_free().

    Returns Soup.URI

  • dup_ssl_trust(): string
  • Thread-safe variation of e_source_webdav_get_ssl_trust(). Use this function when accessing extension from multiple threads.

    The returned string should be freed with g_free() when no longer needed.

    Returns string

  • emit(sigName: "notify::avoid-ifmatch", ...args: any[]): void
  • emit(sigName: "notify::calendar-auto-schedule", ...args: any[]): void
  • emit(sigName: "notify::color", ...args: any[]): void
  • emit(sigName: "notify::display-name", ...args: any[]): void
  • emit(sigName: "notify::email-address", ...args: any[]): void
  • emit(sigName: "notify::order", ...args: any[]): void
  • emit(sigName: "notify::resource-path", ...args: any[]): void
  • emit(sigName: "notify::resource-query", ...args: any[]): void
  • emit(sigName: "notify::soup-uri", ...args: any[]): void
  • emit(sigName: "notify::ssl-trust", ...args: any[]): void
  • emit(sigName: "notify::source", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • 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_avoid_ifmatch(): boolean
  • This setting works around a bug in older Apache mod_dav versions.

    We may deprecate this once Apache 2.2.8 or newer becomes sufficiently ubiquitous, or we figure out a way to detect and work around the bug automatically.

    Returns boolean

  • get_calendar_auto_schedule(): boolean
  • get_color(): string
  • get_data(key?: string): object
  • get_display_name(): string
  • Returns the last known display name of a WebDAV resource, which may differ from the #ESource:display-name property of the #ESource to which extension belongs.

    Returns string

  • get_email_address(): string
  • Returns the user's email address which can be passed to a CalDAV server if the user wishes to receive scheduling messages.

    Returns string

  • get_order(): number
  • 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_resource_path(): string
  • get_resource_query(): string
  • Returns the URI query required to access a resource on a WebDAV server.

    This is typically used when the #ESourceWebdav:resource-path points not to the resource itself but to a web program that generates the resource content on-the-fly. The #ESourceWebdav:resource-query holds the input values for the program.

    Returns string

  • get_ssl_trust(): string
  • Returns an SSL/TLS certificate trust for the extension. The value encodes three parameters, divided by a pipe '|', the first is users preference, can be one of "reject", "accept", "temporary-reject" and "temporary-accept". The second is a host name for which the trust was set. Finally the last is a SHA256 hash of the certificate. This is not meant to be changed by a caller, it is supposed to be manipulated with e_source_webdav_update_ssl_trust() and e_source_webdav_verify_ssl_trust().

    Returns string

  • 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

  • is_floating(): 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

  • property_lock(): void
  • property_unlock(): 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

  • run_dispose(): void
  • set_avoid_ifmatch(avoid_ifmatch: boolean): void
  • This setting works around a bug in older Apache mod_dav versions.

    We may deprecate this once Apache 2.2.8 or newer becomes sufficiently ubiquitous, or we figure out a way to detect and work around the bug automatically.

    Parameters

    • avoid_ifmatch: boolean

      whether the WebDAV server is known to exhibit the bug

    Returns void

  • set_calendar_auto_schedule(calendar_auto_schedule: boolean): void
  • FIXME Document me!

    Parameters

    • calendar_auto_schedule: boolean

      whether the server supports the "calendar-auto-schedule" feature of CalDAV

    Returns void

  • set_color(color: string): void
  • Updates the last known color of a WebDAV resource, as provided by the server.

    The internal copy of color is automatically stripped of leading and trailing whitespace. If the resulting string is empty, %NULL is set instead.

    Parameters

    • color: string

      the color of the WebDAV resource, or %NULL

    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_display_name(display_name: string): void
  • Updates the last known display name of a WebDAV resource, which may differ from the #ESource:display-name property of the #ESource to which extension belongs.

    The internal copy of display_name is automatically stripped of leading and trailing whitespace. If the resulting string is empty, %NULL is set instead.

    Parameters

    • display_name: string

      the display name of the WebDAV resource, or %NULL

    Returns void

  • set_email_address(email_address: string): void
  • Sets the user's email address which can be passed to a CalDAV server if the user wishes to receive scheduling messages.

    The internal copy of email_address is automatically stripped of leading and trailing whitespace. If the resulting string is empty, %NULL is set instead.

    Parameters

    • email_address: string

      the user's email address, or %NULL

    Returns void

  • set_order(order: number): void
  • set_property(property_name: string, value?: any): void
  • set_resource_path(resource_path: string): void
  • Sets the absolute path to a resource on a WebDAV server.

    The internal copy of resource_path is automatically stripped of leading and trailing whitespace. If the resulting string is empty, %NULL is set instead.

    Parameters

    • resource_path: string

      the absolute path to a WebDAV resource, or %NULL

    Returns void

  • set_resource_query(resource_query: string): void
  • Sets the URI query required to access a resource on a WebDAV server.

    This is typically used when the #ESourceWebdav:resource-path points not to the resource itself but to a web program that generates the resource content on-the-fly. The #ESourceWebdav:resource-query holds the input values for the program.

    The internal copy of resource_query is automatically stripped of leading and trailing whitespace. If the resulting string is empty, %NULL is set instead.

    Parameters

    • resource_query: string

      the query to access a WebDAV resource, or %NULL

    Returns void

  • set_soup_uri(soup_uri: Soup.URI): void
  • This is a convenience function which propagates the components of uri to the #ESourceAuthentication extension, the #ESourceSecurity extension, and extension itself. (The "fragment" component of uri is ignored.)

    Parameters

    Returns void

  • set_ssl_trust(ssl_trust: string): void
  • Sets the SSL/TLS certificate trust. See e_source_webdav_get_ssl_trust() for more infomation about its content and how to use it.

    Parameters

    • ssl_trust: string

      the ssl_trust to store, or %NULL to unset

    Returns void

  • Set the SSL trust response, as #ETrustPromptResponse, while keeping the certificate and host information as before. The function does nothing, when none SSL trust is set or when %E_TRUST_PROMPT_RESPONSE_UNKNOWN is used as the response.

    Parameters

    Returns void

  • steal_data(key?: string): 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

  • 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

  • unset_temporary_ssl_trust(): void
  • Updates user's response from a trust prompt, thus it is re-used the next time it'll be needed. An #E_TRUST_PROMPT_RESPONSE_UNKNOWN is treated as a temporary reject, which means the user will be asked again.

    Parameters

    • host: string

      a host name to store the certificate for

    • cert: TlsCertificate

      the invalid certificate of the connection over which host is about to be sent

    • response: TrustPromptResponse

      user's response from a trust prompt for cert

    Returns void

  • Verifies SSL/TLS trust for the given host and cert, as previously stored in the extension with e_source_webdav_update_ssl_trust().

    Parameters

    • host: string

      a host name to store the certificate for

    • cert: TlsCertificate

      the invalid certificate of the connection over which host is about to be sent

    • cert_errors: TlsCertificateFlags

      a bit-or of #GTlsCertificateFlags describing the reason for the cert to be considered invalid

    Returns TrustPromptResponse

  • 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
  • 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 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