🥮 mooncakes.io
    Sign in

    This version of the module is deprecated: Use moonbitlang/pdflite instead

    bobzhang/pdflite/ocg does not have a README file

    PdfBytes

    source
    type PdfBytes = Bytes

    PDF byte strings and byte streams.

    This is an alias for MoonBit Bytes because PDF strings and streams are byte sequences, not Unicode text. Use String only after an explicit PDF text decoding step.

    PdfName

    source

    A PDF name token stored as its raw bytes without the leading slash.

    Names are byte-oriented in the PDF file format. Keeping the original bytes avoids accidental UTF-16 or UTF-8 interpretation while still allowing explicit views and owned-byte access.

    PdfOcg

    source
    pub(all) struct PdfOcg {
      name : Bytes
      intent : Array[
    PdfName    ]
      usage : PdfOcgUsage?
    } derive(Eq, ToJson, 
    Debug    )

    One PDF optional content group dictionary.

    The group's indirect object number is stored outside this record in PdfOptionalContent.ocgs; name is the raw PDF string bytes.

    PdfOcgAppDict

    source
    pub(all) struct PdfOcgAppDict {
      event : PdfOcgEvent
      ocgs : Array[Int]
      category : Array[
    PdfName    ]
    } derive(Eq, ToJson, 
    Debug    )

    Optional-content usage application dictionary.

    ocgs contains indirect object numbers of optional content groups, and category stores the PDF usage-category names for the application.

    PdfOcgConfig

    source
    pub(all) struct PdfOcgConfig {
      name : Bytes?
      creator : Bytes?
      base_state : PdfOcgState
      on : Array[Int]
      off : Array[Int]
      intent : Array[
    PdfName    ]
      usage_applications : Array[PdfOcgAppDict]
      order : Array[(Bytes?, Array[Int])]?
      list_mode : PdfOcgListMode
      radio_button_groups : Array[Array[Int]]?
      locked : Array[Int]
    } derive(Eq, ToJson, 
    Debug    )

    Optional-content configuration dictionary.

    Arrays such as on, off, locked, radio-button groups, and order entries contain OCG indirect object numbers. order preserves the PDF layer-panel grouping labels as raw string bytes.

    PdfOcgEvent

    source
    pub(all) enum PdfOcgEvent {
      OcgView
      OcgPrint
      OcgExport
    } derive(Eq, ToJson, 
    Debug    )

    Event context used by optional-content usage application dictionaries.

    PdfOcgListMode

    source
    pub(all) enum PdfOcgListMode {
      OcgAllPages
      OcgVisiblePages
    } derive(Eq, ToJson, 
    Debug    )

    Policy for whether the layer list is shown on all pages or only visible pages.

    PdfOcgState

    source
    pub(all) enum PdfOcgState {
      OcgOn
      OcgOff
      OcgUnchanged
    } derive(Eq, ToJson, 
    Debug    )

    Default visibility state for optional content groups in a configuration.

    PdfOcgUsage

    source
    pub(all) struct PdfOcgUsage {
      creator_info : (Bytes, 
    PdfName    )?
      language : (Bytes, 
    PdfName    ?)?
      export_state : 
    PdfName    ?
      zoom_min : Double?
      zoom_max : Double?
      print_subtype : 
    PdfName    ?
      print_state : 
    PdfName    ?
      view_state : 
    PdfName    ?
      user : (
    PdfName    , Array[Bytes])?
      page_element_subtype : 
    PdfName    ?
    } derive(Eq, ToJson, 
    Debug    )

    Usage dictionary for a PDF optional content group.

    Byte fields preserve PDF string bytes exactly. Name fields preserve the corresponding PDF names for creator, language, export, zoom, print, view, user, and page-element usage hints.

    PdfOptionalContent

    source
    pub(all) struct PdfOptionalContent {
      ocgs : Array[(Int, PdfOcg)]
      default_config : PdfOcgConfig
      configs : Array[PdfOcgConfig]
    } derive(Eq, ToJson, 
    Debug    )

    Complete catalog optional-content properties.

    ocgs pairs each group's existing indirect object number with the parsed group dictionary. default_config maps /D; configs maps alternate entries from /Configs.

    pdf_ocg_default_config

    source
    fn pdf_ocg_default_config() -> PdfOcgConfig

    Return the PDF default optional-content configuration used when none is set.

    The default has base state OcgOn, /Intent /View, no explicit on/off lists, no order, no radio-button groups, and no locked groups.

    Source Files

    Powered by MoonBit

    Site sourceReport issuePackagesBuild queueSkillsStatistics

    © 2026 mooncakes.io