Sfairadora

  • Reference Guide

Image_editor_def

The definition type of an image editor.
Type
Name
Description
Int|Enki optional
frame_style
The frame style. One of the frame style constants. Only the values FRAME_NONE, FRAME_SIMPLE, and FRAME_DEEP are allowed.
If the value is not specified, an appropriate style is determined automatically based on the editor’s placement.
Int|Enki optional
background
The background color (drawn in the empty space between the image and the frame). One of the dispel background constants.
If the value is not specified, an appropriate color is determined automatically based on whether the editor is read-only or not.
Bool|Enki
min_size_opt
If set TRUE, prevents the image from being shrunken below its actual size.
Bool|Enki
max_size_opt
If set TRUE, prevents the image form being stretched above its actual size.
Bool|Enki
keep_aspect_ratio
If set TRUE, the aspect ratio is preserved when resizing.
The initial value is TRUE.
Int|Enki
stretch_blt_mode
Determines the method of rescaling the image. One of the bitmap resize mode constants.
The initial value is SBM_HALFTONE.
image_size
Forced size of the image. If a coordinate is not specified, the native size is used.
border
The border width between the image and the frame.
Text|Enki
mouse_event
Mouse handling function. A detailed description can be found in the chapter Mouse Handling.
If the type Text is specified, it is an Enki function. If the type Enki is specified, it is a function returning the function’s source text (i.e. an indirect function).
Text|Enki optional
data_getter
The getter functions.
If the type Text is specified, it is an Enki function. If the type Enki is specified, it is a function returning the function’s source text (i.e. an indirect function).
Text|Enki optional
data_setter
The setter functions.
If the type Text is specified, it is an Enki function. If the type Enki is specified, it is a function returning the function’s source text (i.e. an indirect function).
Data_type_def|Enki optional
data_type
The type to be stored to the data item. If not set, the type is inferred from the data item’s type.
Atom|Enki
data_id
The name of the object where the image is located.
Dref|Enki
data_ref
The reference of the image within the object identified above.