🥮 mooncakes.io

    moonbitlang/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.

    PdfOcg::equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcg::equal(PdfOcg, PdfOcg) -> Bool

    PdfOcg::not_equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcg::not_equal(x : PdfOcg, y : PdfOcg) -> Bool

    PdfOcg::to_json

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcg::to_json(PdfOcg) -> Json

    PdfOcg::to_repr

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcg::to_repr(PdfOcg) -> 
    Repr

    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.

    PdfOcgAppDict::equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgAppDict::equal(PdfOcgAppDict, PdfOcgAppDict) -> Bool

    PdfOcgAppDict::not_equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgAppDict::not_equal(x : PdfOcgAppDict, y : PdfOcgAppDict) -> Bool

    PdfOcgAppDict::to_json

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgAppDict::to_json(PdfOcgAppDict) -> Json

    PdfOcgAppDict::to_repr

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgAppDict::to_repr(PdfOcgAppDict) -> 
    Repr

    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.

    PdfOcgConfig::equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgConfig::equal(PdfOcgConfig, PdfOcgConfig) -> Bool

    PdfOcgConfig::not_equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgConfig::not_equal(x : PdfOcgConfig, y : PdfOcgConfig) -> Bool

    PdfOcgConfig::to_json

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgConfig::to_json(PdfOcgConfig) -> Json

    PdfOcgConfig::to_repr

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgConfig::to_repr(PdfOcgConfig) -> 
    Repr

    PdfOcgEvent

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

    Event context used by optional-content usage application dictionaries.

    PdfOcgEvent::equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgEvent::equal(PdfOcgEvent, PdfOcgEvent) -> Bool

    PdfOcgEvent::not_equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgEvent::not_equal(x : PdfOcgEvent, y : PdfOcgEvent) -> Bool

    PdfOcgEvent::to_json

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgEvent::to_json(PdfOcgEvent) -> Json

    PdfOcgEvent::to_repr

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgEvent::to_repr(PdfOcgEvent) -> 
    Repr

    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.

    PdfOcgListMode::equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgListMode::equal(PdfOcgListMode, PdfOcgListMode) -> Bool

    PdfOcgListMode::not_equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgListMode::not_equal(x : PdfOcgListMode, y : PdfOcgListMode) -> Bool

    PdfOcgListMode::to_json

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgListMode::to_json(PdfOcgListMode) -> Json

    PdfOcgListMode::to_repr

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgListMode::to_repr(PdfOcgListMode) -> 
    Repr

    PdfOcgState

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

    Default visibility state for optional content groups in a configuration.

    PdfOcgState::equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgState::equal(PdfOcgState, PdfOcgState) -> Bool

    PdfOcgState::not_equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgState::not_equal(x : PdfOcgState, y : PdfOcgState) -> Bool

    PdfOcgState::to_json

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgState::to_json(PdfOcgState) -> Json

    PdfOcgState::to_repr

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgState::to_repr(PdfOcgState) -> 
    Repr

    PdfOcgUsage

    source

    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.

    PdfOcgUsage::equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgUsage::equal(PdfOcgUsage, PdfOcgUsage) -> Bool

    PdfOcgUsage::not_equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgUsage::not_equal(x : PdfOcgUsage, y : PdfOcgUsage) -> Bool

    PdfOcgUsage::to_json

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgUsage::to_json(PdfOcgUsage) -> Json

    PdfOcgUsage::to_repr

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOcgUsage::to_repr(PdfOcgUsage) -> 
    Repr

    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.

    PdfOptionalContent::equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOptionalContent::equal(PdfOptionalContent, PdfOptionalContent) -> Bool

    PdfOptionalContent::not_equal

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOptionalContent::not_equal(x : PdfOptionalContent, y : PdfOptionalContent) -> Bool

    PdfOptionalContent::to_json

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOptionalContent::to_json(PdfOptionalContent) -> Json

    PdfOptionalContent::to_repr

    source
    #deprecated("implicit trait-method promotion is being removed; call via the trait")
    fn PdfOptionalContent::to_repr(PdfOptionalContent) -> 
    Repr

    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