Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

gsf_off_t: number

Variables

META_NAME_BYTE_COUNT: string

(Integer) Count of bytes in the document.

META_NAME_CASE_SENSITIVE: string

(Unsigned Integer) Identifier representing the case-sensitiveness. of what ?? why is it an integer ??

META_NAME_CATEGORY: string

(String) Category of the document. example???

META_NAME_CELL_COUNT: string

(Integer) Count of cells in the spread-sheet document, if appropriate.

META_NAME_CHARACTER_COUNT: string

(Integer) Count of characters in the document.

TODO See how to sync this with ODF's document-statistic

META_NAME_CODEPAGE: string

(UnsignedShort) The MS codepage to encode strings for metadata 1.14.0 Clarified that this is unique from _NAME_CODEPAGE in msole

META_NAME_COMPANY: string

(String) Name of the company/organization that the "CREATOR" entity is associated with.

1.14.1 Moved from "gsf:company" to "dc:publisher".

META_NAME_CREATOR: string

(String) An entity primarily responsible for making the content of the resource typically a person, organization, or service.

1.14.0 Moved from "gsf" to "dc".

META_NAME_DATE_CREATED: string

(Date as ISO String) A date associated with an event in the life cycle of the resource (creation/publication date). Moved from gsf:date-created to meta:creation-date. This way can be used correctly by OpenDocument and Gnumeric.

META_NAME_DATE_MODIFIED: string

(GsfTimestamp) The last time this document was saved.

1.14.0 Moved from dc:date-modified to dc:date.

META_NAME_DESCRIPTION: string

(String) An account of the content of the resource.

META_NAME_DICTIONARY: string

(None) Reserved name (PID) for Dictionary

META_NAME_DOCUMENT_PARTS: string

(Vector of strings) Names of the 'interesting' parts of the document. In spreadsheets this is a list of the sheet names, and the named expressions. From MSOLE

META_NAME_EDITING_DURATION: string

(Date as ISO String) The total-time taken until the last modification. Moved from "gsf" to "meta". This way can be used correctly by OpenDocument and Gnumeric.

META_NAME_GENERATOR: string

(String) The application that generated this document. AbiWord, Gnumeric, etc...

1.14.0 Moved from "gsf" to "meta".

META_NAME_HEADING_PAIRS: string

(Vector of string value pairs stored in alternating elements) Store the counts of objects in the document as names 'worksheet' and count '4' From MSOLE

META_NAME_HIDDEN_SLIDE_COUNT: string

(Integer) Count of hidden-slides in the presentation document.

META_NAME_IMAGE_COUNT: string

(Integer) Count of images in the document, if appropriate.

META_NAME_INITIAL_CREATOR: string

(String) Specifies the name of the person who created the document initially. 1.14.0 Moved from "gsf" to "meta".

META_NAME_KEYWORD: string

(String) Searchable, indexable keywords. Similar to PDF keywords or HTML's meta block.

META_NAME_KEYWORDS: string

(GsfDocPropVector of String) Searchable, indexable keywords. Similar to PDF keywords or HTML's meta block.

META_NAME_LANGUAGE: string

(String) The locale language of the intellectual content of the resource (basically xx_YY form for us). 1.14.0 Clarified that this is unique from _NAME_CODEPAGE in msole

META_NAME_LAST_PRINTED: string

(GSF_META_NAME_HEADING_PAIRS) The last time this document was printed.

1.14.0 Moved from "gsf" to "dc". 1.14.1 Moved back to "gsf" from "dc".

META_NAME_LAST_SAVED_BY: string

(String) The entity that made the last change to the document, typically a person, organization, or service.

META_NAME_LINE_COUNT: string

(Integer) Count of liness in the document.

META_NAME_LINKS_DIRTY: string

(Boolean) ???????

META_NAME_LOCALE_SYSTEM_DEFAULT: string

(Unsigned Integer) Identifier representing the default system locale.

META_NAME_MANAGER: string

(String) Name of the manager of "CREATOR" entity.

META_NAME_MM_CLIP_COUNT: string

(Integer) Count of "multi-media" clips in the document.

META_NAME_MSOLE_UNKNOWN_17: string

(Unknown) User-defined name

META_NAME_MSOLE_UNKNOWN_18: string

(Unknown) User-defined name

META_NAME_MSOLE_UNKNOWN_19: string

(Boolean) User-defined name

META_NAME_MSOLE_UNKNOWN_20: string

(Unknown) User-defined name

META_NAME_MSOLE_UNKNOWN_21: string

(Unknown) User-defined name

META_NAME_MSOLE_UNKNOWN_22: string

(Boolean) User-defined name

META_NAME_MSOLE_UNKNOWN_23: string

(i4) User-defined name

META_NAME_NOTE_COUNT: string

(Integer) Count of "notes" in the document.

META_NAME_OBJECT_COUNT: string

(Integer) Count of objects (OLE and other graphics) in the document, if appropriate.

META_NAME_PAGE_COUNT: string

(Integer) Count of pages in the document, if appropriate.

META_NAME_PARAGRAPH_COUNT: string

(Integer) Count of paragraphs in the document, if appropriate.

META_NAME_PRESENTATION_FORMAT: string

(String) Type of presentation, like "On-screen Show", "SlideView" etc.

META_NAME_PRINTED_BY: string

(String) Specifies the name of the last person who printed the document.

1.14.0 Moved from "gsf" to "meta".

META_NAME_PRINT_DATE: string

(GsfTimestamp) Specifies the date and time when the document was last printed.

META_NAME_REVISION_COUNT: string

(Integer) Count of revision on the document, if appropriate. Moved from gsf:revision-count to meta:editing-cycles. This way can be used correctly by OpenDocument and Gnumeric.

META_NAME_SCALE: string

(Boolean) ?????

META_NAME_SECURITY: string

(Integer) Level of security.

LevelValue None0 Password protected1 Read-only recommended2 Read-only enforced3 Locked for annotations4
META_NAME_SLIDE_COUNT: string

(Integer) Count of slides in the presentation document.

META_NAME_SPREADSHEET_COUNT: string

(Integer) Count of pages in the document, if appropriate.

META_NAME_SUBJECT: string

(String) The topic of the content of the resource, typically including keywords.

META_NAME_TABLE_COUNT: string

(Integer) Count of tables in the document, if appropriate.

META_NAME_TEMPLATE: string

(String) The template file that is been used to generate this document.

1.14.0 Moved from "gsf" to "meta"

META_NAME_THUMBNAIL: string

(GsfClipData) Thumbnail data of the document, typically a preview image of the document.

META_NAME_TITLE: string

(String) A formal name given to the resource.

META_NAME_WORD_COUNT: string

(Integer) Count of words in the document.

Functions

  • base64_decode_simple(data: Uint8Array, len: number): number
  • Decodes a chunk of base64 encoded data from data back into data.

    Parameters

    • data: Uint8Array

      data stream

    • len: number

      max length of data to decode

    Returns number

  • base64_decode_step(in_: Uint8Array, len: number, out: Uint8Array, state: number, save: number): [number, number, number]
  • Decodes a chunk of base64 encoded data

    Parameters

    • in_: Uint8Array

      input stream

    • len: number

      max length of data to decode

    • out: Uint8Array

      output stream

    • state: number

      holds the number of bits that are stored in save

    • save: number

      leftover bits that have not yet been decoded

    Returns [number, number, number]

  • base64_encode_close(in_: Uint8Array, break_lines: boolean, out: Uint8Array, state: number, save: number): [number, number, number]
  • This funcion should be called to when finished encoding everything, to flush off the last little bit.

    Parameters

    • in_: Uint8Array

      Data to be encoded

    • break_lines: boolean

      Whether to use line breaks

    • out: Uint8Array

      Encoded data.

    • state: number

      holds the number of bits that are stored in save

    • save: number

      leftover bits that have not yet been decoded

    Returns [number, number, number]

  • base64_encode_simple(data: Uint8Array, len: number): number
  • Encodes data from data back into data using base64 encoding.

    Parameters

    • data: Uint8Array

      data stream

    • len: number

      max length of data to encode

    Returns number

  • base64_encode_step(in_: Uint8Array, len: number, break_lines: boolean, out: Uint8Array, state: number, save: number): [number, number, number]
  • Performs an 'encode step', only encodes blocks of 3 characters from in into the output out at a time, saves left-over state in state and save (initialise to 0 on first invocation).

    Parameters

    • in_: Uint8Array

      input stream

    • len: number

      max length of data to decode

    • break_lines: boolean

      Whether to use line breaks

    • out: Uint8Array

      output stream

    • state: number

      holds the number of bits that are stored in save

    • save: number

      leftover bits that have not yet been decoded

    Returns [number, number, number]

  • debug_flag(flag: string): boolean
  • extension_pointer(path: string): string
  • Extracts the extension from the end of a filename (the part after the final '.' in the filename).

    Parameters

    • path: string

      A filename or file path.

    Returns string

  • filename_to_utf8(filename: string, quoted: boolean): string
  • A utility wrapper to make sure filenames are valid utf8. Caller must g_free the result.

    Parameters

    • filename: string

      file name suitable for open(2).

    • quoted: boolean

      if %TRUE, the resulting utf8 file name will be quoted (unless it is invalid).

    Returns string

  • init(): void
  • le_get_double(p: object): number
  • Interpret binary data as a double in little endian order.

    Parameters

    • p: object

      pointer to storage

    Returns number

  • le_get_float(p: object): number
  • Interpret binary data as a float in little endian order.

    Parameters

    • p: object

      pointer to storage

    Returns number

  • le_get_guint64(p: object): number
  • Interpret binary data as a guint64 (8 byte unsigned integer type) in little endian order.

    Parameters

    • p: object

      pointer to storage

    Returns number

  • le_set_double(p: object, d: number): void
  • Store a value of type double in memory in little endian order

    Parameters

    • p: object

      pointer to storage

    • d: number

      double to be stored

    Returns void

  • le_set_float(p: object, f: number): void
  • Store a value of type float in memory in little endian order.

    Parameters

    • p: object

      pointer to storage

    • f: number

      float to be stored

    Returns void

  • mem_dump(ptr: number, len: number): void
  • Dump len bytes from the memory location given by ptr.

    Parameters

    • ptr: number

      memory area to be dumped.

    • len: number

      how many bytes will be dumped.

    Returns void

  • msole_codepage_to_lid(codepage: number): number
  • msole_iconv_win_codepage(): number
  • msole_inflate(input: Gsf.Input, offset: number): Uint8Array
  • Decompresses an LZ compressed stream.

    Parameters

    • input: Gsf.Input

      stream to read from

    • offset: number

      offset into it for start byte of compresse stream

    Returns Uint8Array

  • msole_language_for_lid(lid: number): string
  • msole_lid_for_language(lang: string): number
  • msole_lid_to_codepage(lid: number): number
  • msole_lid_to_codepage_str(lid: number): string
  • odf_get_version(): number
  • odf_get_version_string(): string
  • open_pkg_error_id(): number
  • shutdown(): void
  • value_get_docprop_array(value: any): any[] | null
  • This function returns the array of values inside #GsfDocPropVector. No additional references are created.

    Parameters

    • value: any

      A GValue of type #GsfDocPropVector.

    Returns any[] | null

  • This function returns a pointer to the GsfDocPropVector structure in value. No additional references are created.

    Parameters

    • value: any

      A GValue of type #GsfDocPropVector.

    Returns DocPropVector

  • vba_inflate(input: Gsf.Input, offset: number, size: number, add_null_terminator: boolean): number
  • Decompresses VBA stream.

    Parameters

    • input: Gsf.Input

      stream to read from

    • offset: number

      offset into it for start byte of compressed stream

    • size: number

      size of the returned array

    • add_null_terminator: boolean

      whenever add or not null at the end of array

    Returns number

  • xmlDocFormatDump(output: Gsf.Output, cur: libxml2.Doc, encoding: string, format: boolean): number
  • Dumps the document cur into output.

    Parameters

    • output: Gsf.Output

      #GsfOutput

    • cur: libxml2.Doc

      #xmlDocPtr

    • encoding: string

      The encoding to use.

    • format: boolean

      %TRUE to reformat the output.

    Returns number

  • xml_gvalue_from_str(res: any, t: GType<unknown>, str: string): boolean
  • Try to parse str as a value of type t into res.

    Parameters

    • res: any

      Result value

    • t: GType<unknown>

      Type of data

    • str: string

      Value string

    Returns boolean

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