labelled-line-pinboard-object

labelled-line-pinboard-object Class

Summary

A subclass of pinboard-object which draws a labelled line.

Package

capi

Superclasses

item-pinboard-object
line-pinboard-object

Subclasses

labelled-arrow-pinboard-object

Initargs

`:text-foreground`	A valid color specification, as defined for the graphics-state parameter `foreground`.
`:text-background`	A valid color specification, as defined for the graphics-state parameter `foreground`, or the keyword `:background`, or `nil`.

Accessors

labelled-line-text-foreground
labelled-line-text-background

Description

The class labelled-line-pinboard-object displays a line on a pinboard-layout and draws a label in the middle of it.

Note that the label text is inherited from item.

text-foreground defines the color of the label text.

text-background defines the background for the text, which is the color used to draw a filled rectangle in the area of the text before drawing the text. The value :background means use the background of the pinboard-layout of the object. The value nil means do not draw a background rectangle. The default value of text-background is :background.

Notes

For a description of color specifications, see 15.1 Color specs.

Examples

(capi:contain
 (make-instance 
  'capi:pinboard-layout
  :description
  (list (make-instance 
         'capi:labelled-line-pinboard-object 
         :text "Labelled Line" 
         :start-x 10 :start-y 10 
         :end-x 80 :end-y 60)
        (make-instance 
         'capi:labelled-arrow-pinboard-object 
         :text "Labelled Arrow" 
         :start-x 10 :start-y 70 
         :end-x 80 :end-y 120
         :head-direction :both))))