Gjsify LogoGjsify Logo

Structure encapsulating the mapping logic used to construct a #DeeFilterModel

record

Hierarchy

  • Filter

Index

Constructors

Properties

Callback for freeing the user_data userdata (closure): Free form user data associated with the filter. This pointer will be passed to map_func and map_notify

field
mapFunc: FilterMapFunc

The #DeeModelMapFunc used to construct the initial contents of a #DeeFilterModel

field
mapNotify: FilterMapNotify

Callback invoked when the original model changes

field
userdata: object
name: string

Methods

  • Call the #DeeFilterMapFunc function of a #DeeFilter. When using a #DeeFilterModel you should not call this method yourself.

    Parameters

    • origModel: Dee.Model

      The model that is being filtered

    • filterModel: FilterModel

      The #DeeFilterModel that holds the filtered subset of orig_model

    Returns void

  • Call the #DeeFilterMapNotify function of a #DeeFilter. When using a #DeeFilterModel you should not call this method yourself.

    Parameters

    • origIter: Dee.ModelIter

      The #DeeModelIter added to orig_model

    • origModel: Dee.Model

      The model that is being filtered

    • filterModel: FilterModel

      The #DeeFilterModel that holds the filtered subset of orig_model

    Returns boolean

  • Create a new #DeeFilter with the given parameters. This call will zero the out_filter struct.

    Parameters

    • mapFunc: FilterMapFunc

      The #DeeFilterMapFunc to use for the filter

    • mapNotify: FilterMapNotify

      The #DeeFilterMapNotify to use for the filter

    Returns Dee.Filter

  • Create a #DeeFilter that takes string values from a column in the model and builds a #DeeFilterModel with the rows sorted according to the collation rules of the current locale.

    Parameters

    • column: number

      The index of a column containing the strings to sort after

    Returns Dee.Filter

  • Create a #DeeFilter that takes string values from a column in the model and builds a #DeeFilterModel with the rows sorted descending according to the collation rules of the current locale.

    Parameters

    • column: number

      The index of a column containing the strings to sort after

    Returns Dee.Filter

  • Create a #DeeFilter that only includes rows from the original model which match a variant value in a given column. A #DeeFilterModel created with this filter will be ordered in accordance with its parent model.

    This method will work on any column, disregarding its schema, since the value comparison is done using g_variant_equal(). This means you can use this filter as a convenient fallback when there is no predefined filter for your column type if raw performance is not paramount.

    Parameters

    • column: number

      The index of a column containing the string to match

    • value: GLib.Variant

      A #GVariant value columns must match exactly. The matching semantics are those of g_variant_equal(). If value is floating the ownership will be transfered to the filter

    Returns Dee.Filter

  • newForKeyColumn(column: number, key: string): Dee.Filter
  • Create a #DeeFilter that only includes rows from the original model which has an exact match on some string column. A #DeeFilterModel created with this filter will be ordered in accordance with its parent model.

    Parameters

    • column: number

      The index of a column containing the string key to match

    • key: string

    Returns Dee.Filter

  • Create a #DeeFilter that only includes rows from the original model which match a regular expression on some string column. A #DeeFilterModel created with this filter will be ordered in accordance with its parent model.

    Parameters

    • column: number

      The index of a column containing the string to match

    • regex: GLib.Regex

      The regular expression column must match

    Returns Dee.Filter

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