Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

DEVHELP_FALLBACK_ICON_FILE: string
DEVHELP_ICON_NAME: string
ENV_BUNDLED: string
ENV_CATALOG_PATH: string
ENV_ICON_THEME_PATH: string
ENV_MODULE_PATH: string
ENV_PIXMAP_DIR: string
ENV_TESTING: string
GTKBUILDER_VERSIONING_BASE_MAJOR: number
GTKBUILDER_VERSIONING_BASE_MINOR: number
PROPERTY_DEF_OBJECT_DELIMITER: string
TAG_ACTION: string
TAG_ACTIONS: string
TAG_ACTION_ACTIVATE_FUNCTION: string
TAG_ACTION_SUBMENU_FUNCTION: string
TAG_ADAPTOR: string
TAG_ADD_CHILD_FUNCTION: string
TAG_ADD_CHILD_VERIFY_FUNCTION: string
TAG_ANARCHIST: string
TAG_ATK_PROPERTY: string
TAG_BIND_FLAGS: string
TAG_BIND_PROPERTY: string
TAG_BIND_SOURCE: string
TAG_BOOK: string
TAG_BUILDER_SINCE: string
TAG_CHILD_ACTION_ACTIVATE_FUNCTION: string
TAG_CHILD_GET_PROP_FUNCTION: string
TAG_CHILD_PROPERTY: string
TAG_CHILD_SET_PROP_FUNCTION: string
TAG_CHILD_VERIFY_FUNCTION: string
TAG_COMMENT: string
TAG_COMMON: string
TAG_CONSTRUCTOR_FUNCTION: string
TAG_CONSTRUCT_OBJECT_FUNCTION: string
TAG_CONSTRUCT_ONLY: string
TAG_CONTEXT: string
TAG_CREATE_EDITABLE_FUNCTION: string
TAG_CREATE_EPROP_FUNCTION: string
TAG_CREATE_TYPE: string
TAG_CREATE_WIDGET_FUNCTION: string
TAG_CUSTOM_LAYOUT: string
TAG_DEEP_POST_CREATE_FUNCTION: string
TAG_DEFAULT: string
TAG_DEFAULT_HEIGHT: string
TAG_DEFAULT_PALETTE_STATE: string
TAG_DEFAULT_WIDTH: string
TAG_DEPENDS: string
TAG_DEPENDS_FUNCTION: string
TAG_DEPRECATED: string
TAG_DEPRECATED_SINCE: string
TAG_DESTROY_OBJECT_FUNCTION: string
TAG_DISABLED: string
TAG_DISPLAYABLE_VALUES: string
TAG_DOMAIN: string
TAG_EDITABLE: string
TAG_EVENT_HANDLER_CONNECTED: string
TAG_EXPANDED: string
TAG_FALSE: string
TAG_GENERIC_NAME: string
TAG_GET_CHILDREN_FUNCTION: string
TAG_GET_FUNCTION: string
TAG_GET_INTERNAL_CHILD_FUNCTION: string
TAG_GET_TYPE_FUNCTION: string
TAG_GLADE_CATALOG: string
TAG_GLADE_WIDGET_CLASS: string
TAG_GLADE_WIDGET_CLASSES: string
TAG_GLADE_WIDGET_CLASS_REF: string
TAG_GLADE_WIDGET_GROUP: string
TAG_HAS_CONTEXT: string
TAG_ICON_NAME: string
TAG_ICON_PREFIX: string
TAG_ID: string
TAG_IGNORE: string
TAG_IMPORTANT: string
TAG_INIT_FUNCTION: string
TAG_INTERNAL_CHILDREN: string
TAG_KEY: string
TAG_LIBRARY: string
TAG_MAX_VALUE: string
TAG_MIN_VALUE: string
TAG_MULTILINE: string
TAG_NAME: string
TAG_NEEDS_SYNC: string
TAG_NICK: string
TAG_NO: string
TAG_OPTIONAL: string
TAG_OPTIONAL_DEFAULT: string
TAG_PACKING_ACTIONS: string
TAG_PACKING_DEFAULTS: string
TAG_PACKING_PROPERTIES: string
TAG_PARENT: string
TAG_PARENTLESS_WIDGET: string
TAG_PARENT_CLASS: string
TAG_POST_CREATE_FUNCTION: string
TAG_PROPERTIES: string
TAG_PROPERTY: string
TAG_QUERY: string
TAG_READ_CHILD_FUNCTION: string
TAG_READ_WIDGET_FUNCTION: string
TAG_REMOVE_CHILD_FUNCTION: string
TAG_REPLACE_CHILD_FUNCTION: string
TAG_RESOURCE: string
TAG_SAVE: string
TAG_SAVE_ALWAYS: string
TAG_SET_FUNCTION: string
TAG_SIGNAL: string
TAG_SIGNALS: string
TAG_SPEC: string
TAG_SPECIAL_CHILD_TYPE: string
TAG_SPECIFICATIONS: string
TAG_STOCK: string
TAG_STOCK_ICON: string
TAG_STRING_FROM_VALUE_FUNCTION: string
TAG_TARGETABLE: string
TAG_TEMPLATE_PREFIX: string
TAG_THEMED_ICON: string
TAG_TITLE: string
TAG_TOOLTIP: string
TAG_TOPLEVEL: string
TAG_TRANSFER_ON_PASTE: string
TAG_TRANSLATABLE: string
TAG_TRUE: string
TAG_TYPE: string
TAG_USE_PLACEHOLDERS: string
TAG_VALUE: string
TAG_VALUE_TYPE: string
TAG_VERIFY_FUNCTION: string
TAG_VERSION: string
TAG_VERSION_SINCE: string
TAG_VISIBLE: string
TAG_WEIGHT: string
TAG_WRITE_CHILD_FUNCTION: string
TAG_WRITE_WIDGET_AFTER_FUNCTION: string
TAG_WRITE_WIDGET_FUNCTION: string
TAG_YES: string
UNNAMED_PREFIX: string
WIDGET_ADAPTOR_INSTANTIABLE_PREFIX: string

Class prefix used for abstract classes (ie GtkBin -> GladeInstantiableGtkBin)

XML_TAG_AFTER: string
XML_TAG_CHILD: string
XML_TAG_CLASS: string
XML_TAG_FILENAME: string
XML_TAG_HANDLER: string
XML_TAG_I18N_TRUE: string
XML_TAG_ID: string
XML_TAG_INTERNAL_CHILD: string
XML_TAG_LIB: string
XML_TAG_NAME: string
XML_TAG_OBJECT: string
XML_TAG_PACKING: string
XML_TAG_PLACEHOLDER: string
XML_TAG_PROJECT: string
XML_TAG_PROPERTY: string
XML_TAG_REQUIRES: string
XML_TAG_SIGNAL: string
XML_TAG_SIGNAL_FALSE: string
XML_TAG_SIGNAL_TRUE: string
XML_TAG_SOURCE: string
XML_TAG_SOURCES: string
XML_TAG_STOCK_ID: string
XML_TAG_SWAPPED: string
XML_TAG_TEMPLATE: string
XML_TAG_TYPE: string
XML_TAG_TYPE_FUNC: string
XML_TAG_VERSION: string
XML_TAG_WIDGET: string

Functions

  • catalogAddPath(path: string): void
  • Adds a new path to the list of path to look catalogs for.

    Parameters

    • path: string

      the new path containing catalogs

    Returns void

  • catalogDestroyAll(): void
  • Destroy and free all resources related with every loaded catalog.

    Returns void

  • catalogGetExtraPaths(): string[]
  • catalogIsLoaded(name: string): boolean
  • Loads all available catalogs in the system. First loads catalogs from GLADE_ENV_CATALOG_PATH, then from glade_app_get_catalogs_dir() and finally from paths specified with glade_catalog_add_path()

    Returns Catalog[]

  • catalogRemovePath(path: string): void
  • Remove path from the list of path to look catalogs for. %NULL to remove all paths.

    Parameters

    • path: string

      the new path containing catalogs or %NULL to remove all of them

    Returns void

  • cursorGetAddWidgetPixbuf(): Pixbuf
  • cursorInit(): void
  • displayableValueIsDisabled(type: GType<unknown>, value: string): boolean
  • displayableValueSetDisabled(type: GType<unknown>, value: string, disabled: boolean): void
  • getDebugFlags(): number
  • getDisplayableValue(type: GType<unknown>, value: string): string
  • getValueFromDisplayable(type: GType<unknown>, displayabe: string): string
  • init(): void
  • Initialization function for libgladeui (not #GladeApp) It builds paths, bind text domain, and register icons

    Returns void

  • initDebugFlags(): void
  • propertyDefGetDefaultFromSpec(spec: ParamSpec): any
  • propertyDefMakeFlagsFromString(type: GType<unknown>, string: string): number
  • This function assigns "weight" to each property in its natural order staring from 1. If parent is 0 weight will be set for every #GladePropertyDef in the list. This function will not override weight if it is already set (weight >= 0.0)

    Parameters

    • properties: PropertyDef[]

      a list of #GladePropertyDef

    • parent: GType<unknown>

      the #GType of the parent

    Returns void

  • Updates the property_def_ref with the contents of the node in the xml file. Only the values found in the xml file are overridden.

    Parameters

    • node: Gladeui.XmlNode

      the property node

    • objectType: GType<unknown>

      the #GType of the owning object

    • propertyDefRef: PropertyDef

      a pointer to the property class

    • domain: string

      the domain to translate catalog strings from

    Returns [boolean, PropertyDef | null]

  • registerDisplayableValue(type: GType<unknown>, value: string, domain: string, string: string): void
  • registerTranslatedValue(type: GType<unknown>, value: string, string: string): void
  • setupLogHandlers(): void
  • Sets up a log handler to manage all %G_LOG_LEVEL_MASK errors of domain: GLib, GLib-GObject, Gtk, Gdk, and domainless.

    Returns void

  • This was developed for the purpose of holding a list of 'targets' in an AtkRelation (we are setting it up as a property)

    Returns ParamSpec

  • standardStockAppendPrefix(prefix: string): void
  • typeHasDisplayableValues(type: GType<unknown>): boolean
  • utilCanonicalPath(path: string): string
  • utilCompareStockLabels(a: object, b: object): number
  • This is a #GCompareFunc that compares the labels of two stock items, ignoring any '_' characters. It isn't particularly efficient.

    Parameters

    • a: object

      a #gconstpointer to a #GtkStockItem

    • b: object

      a #gconstpointer to a #GtkStockItem

    Returns number

  • Use this to itterate over all children in a GtkContainer, as it used _forall() instead of _foreach() (and the GTK+ version of this function is simply not exposed).

    Parameters

    Returns Gtk.Widget[]

  • utilDuplicateUnderscores(name: string): string
  • Duplicates name, but the copy has two underscores in place of any single underscore in the original.

    Parameters

    • name: string

      a string

    Returns string

  • utilFileIsWriteable(path: string): boolean
  • Checks whether the file at path is writeable

    Parameters

    • path: string

      the path to the file

    Returns boolean

  • utilFilenameToIconName(value: string): string
  • utilGetFileMtime(filename: string): number
  • Gets the UTC modification time of file filename.

    Parameters

    • filename: string

      A filename

    Returns number

  • utilGetTypeFromName(name: string, haveFunc: boolean): GType
  • Returns the type using the "get type" function name based on name. If the have_func flag is true,name is used directly, otherwise the get-type function is contrived from name then used.

    Parameters

    • name: string

      the name of the #GType - like 'GtkWidget' or a "get-type" function.

    • haveFunc: boolean

      function-name flag -- true if the name is a "get-type" function.

    Returns GType

  • utilHaveDevhelp(): boolean
  • utilIconNameToFilename(value: string): string
  • utilReadPropName(str: string): string
  • Return a usable version of a property identifier as found in a freshly parserd #GladeInterface

    Parameters

    • str: string

      a string

    Returns string

  • utilRemoveScrollEvents(widget: Gtk.Widget): void
  • utilReplace(str: string, a: number, b: number): void
  • Replaces each occurrence of the character a in str to b.

    Parameters

    • str: string

      a string

    • a: number

      a #gchar

    • b: number

      a #gchar

    Returns void

  • utilSearchDevhelp(book: string, page: string, search: string): void
  • utilUrlShow(url: string): boolean
  • Portable function for showing an URL url in a web browser.

    Parameters

    • url: string

      An URL to display

    Returns boolean

  • utilsBooleanFromString(string: string): [boolean, boolean]
  • Parse a boolean value

    Parameters

    • string: string

      the string to convert

    Returns [boolean, boolean]

  • utilsCairoDrawLine(cr: cairo.Context, color: Gdk.Color, x1: number, y1: number, x2: number, y2: number): void
  • utilsCairoDrawRectangle(cr: cairo.Context, color: Gdk.Color, filled: boolean, x: number, y: number, width: number, height: number): void
  • utilsEnumStringFromValue(enumType: GType<unknown>, value: number): string
  • utilsEnumStringFromValueDisplayable(flagsType: GType<unknown>, value: number): string
  • utilsEnumValueFromString(enumType: GType<unknown>, strval: string): number
  • utilsFlagsStringFromValue(enumType: GType<unknown>, value: number): string
  • utilsFlagsStringFromValueDisplayable(flagsType: GType<unknown>, value: number): string
  • utilsFlagsValueFromString(enumType: GType<unknown>, strval: string): number
  • Get's the pointer position relative to widget, while window and device are not absolutely needed, they should be passed wherever possible.

    Parameters

    • widget: Gtk.Widget

      The widget to get the mouse position relative for

    • window: Gdk.Window

      The window of the current event, or %NULL

    • device: Gdk.Device

      The device, if not specified, the current event will be expected to have a device.

    • x: number

      The location to store the mouse pointer X position

    • y: number

      The location to store the mouse pointer Y position

    Returns void

  • utilsGetPspecFromFuncname(funcname: string): ParamSpec | null
  • This function is meant to be attached to key-press-event of a toplevel, it simply allows the window contents to treat key events /before/ accelerator keys come into play (this way widgets dont get deleted when cutting text in an entry etc.). Creates a liststore suitable for comboboxes and such to chose from a variety of types.

    Parameters

    Returns number

  • utilsListstoreFromEnumType(enumType: GType<unknown>, includeEmpty: boolean): Gtk.ListStore
  • Creates a liststore suitable for comboboxes and such to chose from a variety of types.

    Parameters

    • enumType: GType<unknown>

      A #GType

    • includeEmpty: boolean

      whether to prepend an "Unset" slot

    Returns Gtk.ListStore

  • Render an icon representing the pointer mode. Best view with sizes bigger than GTK_ICON_SIZE_LARGE_TOOLBAR.

    Parameters

    Returns Pixbuf

  • utilsReplaceHomeDirWithTilde(path: string): string
  • utilsStringFromValue(value: any): string
  • Serializes #GValue into a string (using glade conversion routines)

    Parameters

    • value: any

      a #GValue to convert

    Returns string

  • Allocates and sets a #GValue of type type set to string (using glade conversion routines)

    Parameters

    • type: GType<unknown>

      a #GType to convert with

    • string: string

      the string to convert

    • project: Gladeui.Project

      the #GladeProject to look for formats of object names when needed

    Returns any

  • xmlGetBoolean(node: Gladeui.XmlNode, name: string, default_: boolean): boolean
  • xmlGetPropertyBoolean(nodeIn: Gladeui.XmlNode, name: string, default_: boolean): boolean
  • xmlGetPropertyDouble(nodeIn: Gladeui.XmlNode, name: string, default_: number): number
  • xmlGetPropertyInt(nodeIn: Gladeui.XmlNode, name: string, default_: number): number
  • xmlGetPropertyStringRequired(nodeIn: Gladeui.XmlNode, name: string, xtra: string): string
  • xmlGetPropertyVersion(nodeIn: Gladeui.XmlNode, name: string, major: number, minor: number): boolean
  • xmlGetValueInt(nodeIn: Gladeui.XmlNode, name: string, val: number): boolean
  • Gets an integer value for a node either carried as an attribute or as the content of a child.

    Parameters

    • nodeIn: Gladeui.XmlNode

      a #GladeXmlNode

    • name: string

      a string

    • val: number

      a pointer to an #int

    Returns boolean

  • xmlGetValueIntRequired(node: Gladeui.XmlNode, name: string, val: number): boolean
  • This is a wrapper around glade_xml_get_value_int(), only it emits a g_warning() if node did not contain the requested tag

    Parameters

    • node: Gladeui.XmlNode

      a #GladeXmlNode

    • name: string

      a string

    • val: number

      a pointer to an #int

    Returns boolean

  • xmlGetValueStringRequired(node: Gladeui.XmlNode, name: string, xtraInfo: string): string
  • just a small wrapper around glade_xml_search_child that displays an error if the child was not found

    Parameters

    • tree: Gladeui.XmlNode

      A #GladeXmlNode

    • name: string

      the name of the child

    Returns Gladeui.XmlNode | null

  • Sets the property name in node_in to val

    Parameters

    • nodeIn: Gladeui.XmlNode

      a #GladeXmlNode

    • name: string

      a string

    • val: string

      a string

    Returns void

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