Canvas (u.0e26053ad794216b4ee413090cdeb75c.stk.0.3.0.doc.stk.Stk.Canvas)

Items

Sourceclass virtual item : ?group:group option -> ?x:int option -> ?y:int option -> unit -> object ... end

This virtual class defines the item interface. Most of the virtual methods correspond to methods of Widget.widget and are defined by inherting from Widget.widget or other widgets.

Source

class virtual full_item : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata:
  Widget.wdata
    option -> ?group:group option -> ?x:int option -> ?y:int option -> 
  unit -> object ... end

A full_item is a Widget.widget with item interface.

Source

class virtual +'b container_item : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata:
  Widget.wdata
    option -> ?group:group option -> ?x:int option -> ?y:int option -> 
  unit -> object ... end

a container_item is a Container.container with item interface.

Source

class group : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata:
  Widget.wdata
    option -> ?group:group option -> ?x:int option -> ?y:int option -> 
  unit -> object ... end

A group is a [full_item] container_item. Its kind is "canvas_group".

Source

class rect : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata:
  Widget.wdata
    option -> ?group:group option -> ?x:int option -> ?y:int option -> w:
  int -> h:int -> unit -> object ... end

An item to draw a rectangle. Its kind is "rect". Width and height of the rectangle can be specified with optional arguments w and h.

Sourceval bezier_points : (int * int) list -> (G.t * (int * int) list) option

Source

class bezier_curve : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata:
  Widget.wdata
    option -> ?group:group option -> ?x:int option -> ?y:int option -> ?points:
  (int * int) list
    option -> unit -> object ... end

Widgets inheriting a widget and an item keeps the original widget kind but can be identified specifically in theming for example by using "canvas > <kind>".

Source

class bin : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata:
  Widget.wdata
    option -> ?group:group option -> ?x:int option -> ?y:int option -> 
  unit -> object ... end

A Bin.bin as item.

Source

class label : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata:
  Widget.wdata
    option -> ?group:group option -> ?x:int option -> ?y:int option -> 
  unit -> object ... end

A Text.label as item.

Source

class glyph : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata:
  Widget.wdata
    option -> ?group:group option -> ?x:int option -> ?y:int option -> 
  unit -> object ... end

A Text.glyph as item.

Source

class 'a box : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata:
  Widget.wdata
    option -> ?group:group option -> ?x:int option -> ?y:int option -> 
  unit -> object ... end

A Pack.box as item.

Source

class paned : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata:
  Widget.wdata
    option -> ?group:group option -> ?x:int option -> ?y:int option -> 
  unit -> object ... end

A Pack.paned as item.

Source

class fixed_size : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata:
  Widget.wdata
    option -> ?group:group option -> ?x:int option -> ?y:int option -> ?w:
  int
    option -> ?h:int option -> unit -> object ... end

A Bin.fixed_size as item.

Source

class 'a flex : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata:
  Widget.wdata
    option -> ?group:group option -> ?x:int option -> ?y:int option -> 
  unit -> object ... end

A Flex.flex as item.

Convenient functions to create items

These convenient functions are used to create items. They all take x and y optional arguments to specify the coordinates of the created item, and group to specify the group the item belongs to. Other arguments are generic widget arguments or arguments specific to the kind of item.

Source

val group : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?x:int ->
  ?y:int ->
  unit ->
  group

Creates a group.

Source

val rect : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?x:int ->
  ?y:int ->
  w:int ->
  h:int ->
  unit ->
  rect

Creates a rect.

Source

val bezier_curve : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?x:int ->
  ?y:int ->
  ?points:(int * int) list ->
  unit ->
  bezier_curve

Creates a bezier_curve.

Source

val bin : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?x:int ->
  ?y:int ->
  unit ->
  bin

Creates a bin.

Source

val label : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?x:int ->
  ?y:int ->
  string ->
  label

Creates a label.

Source

val glyph : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?x:int ->
  ?y:int ->
  int ->
  glyph

Creates a glyph.

Source

val vbox : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?x:int ->
  ?y:int ->
  unit ->
  'a box

Creates a box with vertical orientation.

Source

val hbox : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?x:int ->
  ?y:int ->
  unit ->
  'a box

Creates a box with horizontal orientation.

Source

val vpaned : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?x:int ->
  ?y:int ->
  unit ->
  paned

Creates a paned with vertical orientation.

Source

val hpaned : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?x:int ->
  ?y:int ->
  unit ->
  paned

Creates a paned with horizontal orientation.

Source

val fixed_size : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?x:int ->
  ?y:int ->
  ?w:int ->
  ?h:int ->
  unit ->
  fixed_size

Creates a fixed_size.

Source

val flex : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?x:int ->
  ?y:int ->
  ?orientation:Props.orientation ->
  ?justification:Flex.justification ->
  ?items_alignment:Flex.items_alignment ->
  ?content_alignment:Flex.content_alignment ->
  ?inter_space:int ->
  ?wrap:bool ->
  ?wrap_on_break:bool ->
  ?collapse_spaces:bool ->
  unit ->
  'a flex

Creates a flex.

Source

class canvas : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata:
  Widget.wdata
    option -> unit -> object ... end

Source

val canvas : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?pack:(Widget.widget -> unit) ->
  unit ->
  canvas

Convenient function to create a canvas. See Widget arguments for arguments.

Module `Stk.Canvas`Source

Items

Convenient functions to create items

Canvas widget