package chamo

  1. Overview
  2. Docs
package chamo
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Chamo.MulticlipSource

Multi-contents clipboards. The Multiclip_gui module contains material to create graphical interface for these clipboards.

Sourcetype multiclip
Sourcetype id
Sourceval id_wrapper : id Ocf.wrapper
Sourceval string_of_id : id -> string
Sourceval id_of_string : string -> id
Sourceval create_multiclip : ?abst_len:int -> unit -> multiclip

Create a multiclip.

  • parameter abst_len

    is the length of the abstract string displayed in the list.

Sourceval add : multiclip -> ?id:id -> ?abs:string -> string -> id

Add a string to the multiclip.

  • parameter abs

    can be used to force the abstract. By default, it is obtained by chopping the given string at the abstract length abst_len specified at the multiclip creation.

Sourceval elements : multiclip -> (id * string * string) list

The list of elements in the multiclip, as a list of triples (id, abstract, string).

Sourceval ids : multiclip -> id list

The sorted list of ids in the multiclip.

Sourceval get : multiclip -> id -> (string * string) option

Retrieve the abstract and string associated to the given id, if present.

Sourceval remove : multiclip -> id -> unit

Remove an element, by giving its id.

Storable multiclips

These multiclips can be stored to a file given at creation time.

Sourcetype storable_multiclip
Sourceval create_storable_multiclip : ?abst_len:int -> string -> storable_multiclip

create_storable_multiclip file creates a new multiclip, stored and read from the given file.

Sourceval read_multiclip : storable_multiclip -> unit

Reload the contents of the multiclip from its file.

Sourceval write_multiclip : storable_multiclip -> unit

Write the contents of the multiclip into its file.

Sourceval storable_get_multiclip : storable_multiclip -> multiclip

Get the raw multiclip.

Sourceval storable_get_file : storable_multiclip -> string

Get the file use by the given multiclip.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct