2.5.28 style-delta%

Version: 4.1

style-delta% : class?
superclass: object%

A style-delta% object encapsulates a style change. The changes expressible by a delta include:

changing the font family
changing the font face
changing the font size to a new value
enlarging the font by an additive amount
enlarging the font by a multiplicative amount, etc.
changing the font style (normal, {\it italic}, or {\sl slant})
toggling the font style
changing the font to {\it italic} if it is currently {\sl slant}, etc.
changing the font weight, etc.
changing the underline, etc.
changing the vertical alignment, etc.
changing the foreground color
dimming or brightening the foreground color, etc.
changing the background color, etc.
changing text backing transparency

The set-delta method is convenient for most style delta settings; it takes a high-level delta specification and sets the internal delta information.

To take full advantage of a style delta, it is necessary to understand the internal on/off settings that can be manipulated through methods such as set-weight-on. For example, the font weight change is specified through the weight-on and weight-off internal settings. Roughly, weight-on turns on a weight setting when it is not present and weight-off turns off a weight setting when it is present. These two interact precisely in the following way:

If both weight-on and weight-off are set to 'base, then the font weight is not changed.
If weight-on is not 'base, then the weight is set to weight-on.
If weight-off is not 'base, then the weight will be set back to 'normal when the base style has the weight weight-off.
If both weight-on and weight-off are set to the same value, then the weight is toggled with respect to that value: if the base style has the weight weight-on, then weight is changed to 'normal; if the base style has a different weight, it is changed to weight-on.
If both weight-on and weight-off are set, but to different values, then the weight is changed to weight-on only when the base style has the weight weight-off.

Font styles, smoothing, underlining, and alignment work in an analogous manner.

The possible values for alignment-on and alignment-off are:

'base
'top
'center
'bottom

The possible values for style-on and style-off are:

'base
'normal
'italic
'slant

The possible values for smoothing-on and smoothing-off are:

'base
'default
'partly-smoothed
'smoothed
'unsmoothed

The possible values for underlined-on and underlined-off are:

#f (acts like 'base)
#t

The possible values for size-in-pixels-on and size-in-pixels-off are:

#f (acts like 'base)
#t

The possible values for transparent-text-backing-on and transparent-text-backing-off are:

#f (acts like 'base)
#t

The possible values for weight-on and weight-off are:

'base
'normal
'bold
'light

The family and face settings in a style delta are interdependent:

When a delta’s face is #f and its family is 'base, then neither the face nor family are modified by the delta.
When a delta’s face is a string and its family is 'base, then only face is modified by the delta.
When a delta’s family is not 'base, then both the face and family are modified by the delta. If the delta’s face is #f, then applying the delta sets a style’s face to #f, so that the family setting prevails in choosing a font.

(make-object style-delta% [change-command])
→ (is-a?/c style-delta%)

change-command

:

(one-of/c 'change-nothing
          'change-normal
          'change-toggle-underline
          'change-toggle-size-in-pixels
          'change-normal-color
          'change-bold)

=

'change-nothing
(make-object style-delta% change-command v)
→ (is-a?/c style-delta%)

change-command

:

(one-of/c 'change-family
          'change-style
          'change-toggle-style
          'change-weight
          'change-toggle-weight
          'change-smoothing
          'change-toggle-smoothing
          'change-alignment)
  v : symbol
(make-object style-delta% change-command v)
→ (is-a?/c style-delta%)

change-command

:

(one-of/c 'change-size
          'change-bigger
          'change-smaller)
  v : (integer-in 0 255)
(make-object style-delta% change-command v)
→ (is-a?/c style-delta%)

change-command

:

(one-of/c 'change-underline
          'change-size-in-pixels)
  v : any/c

The initialization arguments are passed on to set-delta.

(send a-style-delta collapse delta) → boolean?
delta : (is-a?/c style-delta%)

Tries to collapse into a single delta the changes that would be made by applying this delta after a given delta. If the return value is #f, then it is impossible to perform the collapse. Otherwise, the return value is #t and this delta will contain the collapsed change specification.

(send a-style-delta copy delta) → void?
delta : (is-a?/c style-delta%)

Copies the given style delta’s settings into this one.

(send a-style-delta equal? delta) → boolean?
delta : (is-a?/c style-delta%)

Returns #t if the given delta is equivalent to this one in all contexts or #f otherwise.

(send a-style-delta get-alignment-off)
→ (one-of/c 'base 'top 'center 'bottom)

2.1	Windowing Classes
2.2	Windowing Functions
2.3	Drawing Classes
2.4	Drawing Functions
2.5	Editor Classes
2.6	Editor Functions
2.7	WXME Decoding

2.5.1	add-color<%>
2.5.2	editor<%>
2.5.3	editor-admin%
2.5.4	editor-canvas%
2.5.5	editor-data%
2.5.6	editor-data-class%
2.5.7	editor-data-class-list<%>
2.5.8	editor-snip-editor-admin<%>
2.5.9	editor-snip%
2.5.10	editor-stream-in%
2.5.11	editor-stream-in-base%
2.5.12	editor-stream-in-bytes-base%
2.5.13	editor-stream-out%
2.5.14	editor-stream-out-base%
2.5.15	editor-stream-out-bytes-base%
2.5.16	editor-wordbreak-map%
2.5.17	image-snip%
2.5.18	keymap%
2.5.19	mult-color<%>
2.5.20	pasteboard%
2.5.21	readable-snip<%>
2.5.22	snip%
2.5.23	snip-admin%
2.5.24	snip-class%
2.5.25	snip-class-list<%>
2.5.26	string-snip%
2.5.27	style<%>
2.5.28	style-delta%
2.5.29	style-list%
2.5.30	tab-snip%
2.5.31	text%