winternal !! alert_beep (Code: Int) → ()
Alert sound. [Requires: active winsession.] Emit alert sound (as defined by Code). |
| alert_box ►
winternal !! alert_box (Win: Window, Title: String, Message: String, Flags: Int) → ()
Alert modal window. [Requires: active winsession.] Open alert window (modal), with text Message, caption Title and options Flags (belonging to window Win). |
◄ alert_beep | arc ►
[ Graphic ]
graphics !! arc (Left_Top: Point, Right_Bottom: Point, StartRay: Point, EndRay: Point) → Bool
Draw elliptical arc. [Requires: active graphic context.] [Affected by: plot mode.] Draws elliptical arc in [Left_Top : Right_Bottom] from StartRay to EndRay with current plot mode. (Note: both StartRay and EndRay are defined relative to center of ellipse.) |
winternal !! caret_loc (Win: Window, [Location: Point]) → ()
Place/remove window caret. [Requires: active winsession.] Place caret of window Win to Point (or remove it, if no Point specified). |
◄ arc | caret_shape ►
winternal !! caret_shape (Win: Window, [Shape: Point]) → ()
Enable/disable window caret. [Requires: active winsession.] Enable flashing rectangle caret with extent Shape (or disable it, if Shape is empty) in window Win. |
[ Graphic ]
graphics !! chord (Left_Top: Point, Right_Bottom: Point, StartRay: Point, EndRay: Point) → Bool
Draw elliptical chord. [Requires: active graphic context.] [Affected by: plot/fill mode.] Draws elliptical chord in [Left_Top : Right_Bottom] from StartRay to EndRay with current plot & fill mode. (Note: both StartRay and EndRay are defined relative to center of ellipse.) |
◄ caret_shape | clip_area ►
graphics !! clip_area ((LeftTop: Point, RightBottom: Point), @Core: Any) → Any
Rectangular clipping wrapper. [Requires: active graphic context.] Evaluate Core with clipping area [LeftTop : RightBottom]. |
◄ chord | create_metadoc ►
[ MetaDoc | Constructor ]
metadoc !! create_metadoc (Title: String) → MetaDoc
Metadocument constructor. Create and return new meta document (with name Title). |
◄ clip_area | create_metaview ►
[ MetaDoc | Constructor ]
metadoc !! create_metaview (Document: MetaDoc, Owner: Object) → ()
Create new metadocument visual. Create and return new visual for Document, belonging to Owner. |
◄ create_metadoc | create_window ►
[ Windows | Internal | Constructor ]
winternal !! create_window (Parent: Window, Widget: Object, Title: String, Left_Top: Point, Width_Height: Point, Flags: Int) → Window
Create new window. [Requires: active winsession.] Create and open new window, belonging to Parent window and containing Widget object (with caption Title, location Left_Top, extent Width_Height, and options Flags). |
◄ create_metaview | delete_metaview ►
[ MetaDoc | Destructor ]
metadoc !! delete_metaview (Document: MetaDoc, Owner: Object) → ()
Delete metadocument visual. Delete visual of Document belonging to Owner. |
◄ create_window | destroy_metadoc ►
[ MetaDoc | Destructor ]
metadoc !! destroy_metadoc (Document: MetaDoc) → ()
Metadocument destructor. Delete meta document Document. |
◄ delete_metaview | destroy_window ►
[ Windows | Internal | Destructor ]
winternal !! destroy_window (Win: Window) → ()
Destroy window. [Requires: active winsession.] Close and destroy window Win. |
◄ destroy_metadoc | draw_metaview ►
[ MetaDoc ]
metadoc !! draw_metaview (Document: MetaDoc, Owner: Object, Offset: Point, Area: Rect, Flags: Int) → Int
Draw meta-document visual. Draw visual of Document belonging to Owner (only region Area, shifed by vector Offset, with options Flags). |
◄ destroy_window | dump_metadoc ►
metadoc !! dump_metadoc (Document: MetaDoc) → ()
Metadocument dumping. Dump meta document internals (to standard output log). |
◄ draw_metaview | fill ►
[ Graphic ]
graphics !! fill (Left_Top: Point, Right_Bottom: Point) → Bool
Fill rectangle. [Requires: active graphic context.] [Affected by: fill mode.] Fills rectangle area [Left_Top : Right_Bottom] with current fill settings. |
◄ dump_metadoc | fill_color ►
graphics !! fill_color (FillColor: Color, @Core: Any) → Any
Fill color wrapper. [Requires: active graphic context.] [Affects: fill mode.] Evaluates Core, with fill color set to FillColor. |
◄ fill | fill_disable ►
graphics !! fill_disable (Flag: Bool, @Core: Any) → Any
Fill enable wrapper. [Requires: active graphic context.] [Affects: fill mode.] Evaluates Core, with filling disabled (if Flag is true). |
◄ fill_color | font_bgcolor ►
graphics !! font_bgcolor (FontBgColor: Color, @Core: Any) → Any
Font background color wrapper. [Requires: active graphic context.] [Affects: text mode.] Evaluates Core, with background color set to FontBgColor. |
◄ fill_disable | font_face ►
graphics !! font_face (FontFace: String, @Core: Any) → Any
Font face wrapper. [Requires: active graphic context.] [Affects: text mode.] Evaluates Core, with font face set to FontFace. |
◄ font_bgcolor | font_fgcolor ►
graphics !! font_fgcolor (FontFgColor: Color, @Core: Any) → Any
Font foreground color wrapper. [Requires: active graphic context.] [Affects: text mode.] Evaluates Core, with foreground color set to FontFgColor. |
◄ font_face | font_inverse ►
graphics !! font_inverse (@Core: Any) → Any
Font color inversion wrapper. [Requires: active graphic context.] [Affects: text mode.] Evaluates Core, with swapped foreground/background colors. |
◄ font_fgcolor | font_italic ►
graphics !! font_italic (FontItalic: Bool, @Core: Any) → Any
Font italics mode wrapper. [Requires: active graphic context.] [Affects: text mode.] Evaluates Core, with text italicizing mode set to FontItalic. |
◄ font_inverse | font_overstrike ►
graphics !! font_overstrike (FontOverstrike: Bool, @Core: Any) → Any
Font overstrike mode wrapper. [Requires: active graphic context.] [Affects: text mode.] Evaluates Core, with text overstriking mode set to FontOverstrike. |
◄ font_italic | font_size ►
graphics !! font_size (FontSize: Int, @Core: Any) → Any
Font size wrapper. [Requires: active graphic context.] [Affects: text mode.] Evaluates Core, with font size (in pixels) set to FontSize. |
◄ font_overstrike | font_underline ►
graphics !! font_underline (FontUnderline: Bool, @Core: Any) → Any
Font underline mode wrapper. [Requires: active graphic context.] [Affects: text mode.] Evaluates Core, with text underlining mode set to FontUnderline. |
◄ font_size | font_weight ►
graphics !! font_weight (FontWeight: Int, @Core: Any) → Any
Font weight wrapper. [Requires: active graphic context.] [Affects: text mode.] Evaluates Core, with font weight set to FontWeight (0: default; > 0: bolder; < 0: thinner). |
◄ font_underline | font_width ►
graphics !! font_width (FontWidth: Int, @Core: Any) → Any
Font width wrapper. [Requires: active graphic context.] [Affects: text mode.] Evaluates Core, with font width (in pixels) set to FontWidth. |
◄ font_weight | format_metaview ►
[ MetaDoc ]
metadoc !! format_metaview (Document: MetaDoc, Owner: Object, Extent: Point, Flags: Int) → Point
Format meta-document visual. Format visual of Document (belonging to Owner) to fill Extent. (Returns: real extent of formatted document.) |
◄ font_width | frame3D ►
[ Graphic ]
graphics !! frame3D (Left_Top: Point, Right_Bottom: Point, Inset: Point, Normal: Color, Lite: Color, Dark: Color) → Bool
Draw frame with 3D look. [Requires: active graphic context.] Draws 3D frame, in region [Left_Top : Right_Bottom], with internal Inset. (Filled with Normal (central area), Lite (left/top sides) and Dark (right/bottom sides) colors.) |
◄ format_metaview | get_meta_name ►
[ MetaDoc ]
metadoc !! get_meta_name (Document: MetaDoc) → String
Name of metadocument. Retrieve name of meta document Document. |
◄ frame3D | get_text_height ►
[ Graphic ]
graphics !! get_text_height () → (Int, Int, Int)
Get text height metrics. [Requires: active graphic context.] Get current text height metrics: [Ascent Descent Leading]. |
◄ get_meta_name | get_text_org ►
[ Graphic ]
graphics !! get_text_org () → Point
Get current text origin. [Requires: active graphic context.] Return current text origin point: [OrgX OrgY]. |
◄ get_text_height | grid_extent ►
[ Graphic ]
graphics !! grid_extent (GridOrigin: Point, GridStep: Point, GridCounts: Point, ) → Point
Calculate rectangular grid extent. Returns extent of grid (defined by offset GridOrigin, cell size GridStep and cell counters GridCounts). |
◄ get_text_org | image_blit ►
[ Graphic ]
graphics !! image_blit (SrcImage: Image, SrcOrigin: Point, DstImage: Image, DstOrigin: Point, Extent: Point) → ()
Blit image region between image(s) and/or display. [Requires: active graphic context.] Copy rectangle (with dimensions Extent); from source image SrcImage (at SrcOrigin) to destination image DstImage (at DstOrigin). (If SrcImage and/or DstImage is undef, current graphic context is used instead.) |
◄ grid_extent | image_create ►
[ Graphic | Constructor ]
graphics !! image_create (Extent: Point) → Image
Create new image. [Requires: active graphic context.] Creates empty bitmap image (with dimensions Extent). |
◄ image_blit | image_destroy ►
[ Graphic | Destructor ]
graphics !! image_destroy (Image: Image) → ()
Destroy image. [Requires: active graphic context.] Destroys bitmap image Image. |
◄ image_create | image_extent ►
[ Graphic ]
graphics !! image_extent (Image: Image) → Point
Get image extent. Returns extent of bitmap image Image. |
◄ image_destroy | image_stretch ►
[ Graphic ]
graphics !! image_stretch (SrcImage: Image, SrcOrigin: Point, SrcExtent: Point, DstImage: Image, DstOrigin: Point, DstExtent: Point) → ()
Stretch image region between image(s) and/or display. [Requires: active graphic context.] Copy rectangle (expanding or shrinking it on need), from source image SrcImage (at [SrcOrigin : SrcExtent]) to destination image DstImage (at [DstOrigin : DstExtent]). (If SrcImage and/or DstImage is undef, current graphic context is used instead.) |
◄ image_extent | is_active ►
graphics !! is_active () → Bool
Check for active graphic context. Returns true, if active graphic context is present. |
◄ image_stretch | line ►
[ Graphic ]
graphics !! line (From: Point, To: Point) → Bool
Plot line. [Requires: active graphic context.] [Affected by: plot mode.] Draws line from point From (inclusive) to point To (exclusive) with current plot mode. |
◄ is_active | loop_metaview_base ►
[ MetaDoc ]
metadoc !! loop_metaview_base (Document: MetaDoc, Owner: Object, Offset: Point, Area: Rect, Callee: Func) → ()
Meta-document visual baselines enumerator. Invoke Callee ! (Y: Int) for all baselines in meta-visual Document (Owner). |
◄ line | loop_metaview_clip ►
[ MetaDoc ]
metadoc !! loop_metaview_clip (Document: MetaDoc, Owner: Object, Offset: Point, Area: Rect, Callee: Func) → ()
Meta-document visual cliprects enumerator. Invoke Callee ! (R: Rect) for all clip rectangles in meta-visual Document (Owner). |
◄ loop_metaview_base | loop_metaview_node ►
[ MetaDoc ]
metadoc !! loop_metaview_node (Document: MetaDoc, Owner: Object, Offset: Point, Area: Rect, Callee: Func) → ()
Meta-document visual nodes enumerator. Invoke Callee ! (Loc: Point) for all location points in meta-visual Document (Owner). |
◄ loop_metaview_clip | map_grid_point ►
[ Graphic ]
graphics !! map_grid_point (GridOrigin: Point, GridStep: Point, GridCounts: Point, Loc: Point) → Point
Map point to rectangular grid. Locate point (Loc) in grid (defined by offset GridOrigin, cell size GridStep and cell counters GridCounts). Returns cell location (or undef, if point is outside grid). |
◄ loop_metaview_node | map_grid_rect ►
[ Graphic ]
graphics !! map_grid_rect (GridOrigin: Point, GridStep: Point, GridCounts: Point, Left_Top: Point, Right_Bottom: Point) → Rect
Map rectangle to rectangular grid. Locate rectangle [Left_Top : Right_Bottom] in grid (defined by origin GridOrigin, cell size GridStep and cell counters GridCounts). Returns cells rectangle (LeftTopCell, RightBottomCell) (or undef, if no intersection between rectangle and grid). |
◄ map_grid_point | measure_metadoc ►
[ MetaDoc ]
metadoc !! measure_metadoc (Document: MetaDoc) → ()
Metadocument internal calculations. Calculate meta document internal text metrics (for active display context). |
◄ map_grid_rect | message_loop ►
winternal !! message_loop (MessageHandler: Func, @Initial: Any) → Int
Window session message loop. [Requires: active winsession.] Proceed with session message loop, passing messages to MessageHandler. (Initial is evaluated before session.) (Returns internal counter of messages processed.) |
◄ measure_metadoc | oval ►
[ Graphic ]
graphics !! oval (Left_Top: Point, Right_Bottom: Point) → Bool
Draw oval/ellipse. [Requires: active graphic context.] [Affected by: plot/fill mode.] Draws ellipse bound by [Left_Top : Right_Bottom]; with current plot & fill mode. |
◄ message_loop | pixel ►
[ Graphic ]
graphics !! pixel (At: Point, Color: Color) → Bool
Put pixel. [Requires: active graphic context.] Put signle pixel in current graphic environment at point At with color Color. |
◄ oval | pixel_fill ►
[ Graphic ]
graphics !! pixel_fill (Left_Top: Point, Right_Bottom: Point, CalcPoint: Func) → ()
Fill rectangle with calculated pixels. [Requires: active graphic context.] Fill area [Left_Top : Right_Bottom] with pixel values (calculated for each point (x, y) by CalcPoint ! (x, y) ). |
[ Graphic ]
graphics !! plot (At: Point) → Bool
Plot point. [Requires: active graphic context.] [Affected by: plot mode.] Draws point at At with current plot mode. |
◄ pixel_fill | plot_color ►
graphics !! plot_color (PlotColor: Color, @Core: Any) → Any
Plot color wrapper. [Requires: active graphic context.] [Affects: plot mode.] Evaluates Core, with plot color set to PlotColor. |
◄ plot | plot_disable ►
graphics !! plot_disable (Flag: Bool, @Core: Any) → Any
Plot enable wrapper. [Requires: active graphic context.] [Affects: plot mode.] Evaluates Core, with plotting disabled (if Flag is true). |
◄ plot_color | polygon ►
[ Graphic ]
graphics !! polygon (Vertex0: Point, Vertex1: Point, ..., VertexN: Point, ) → Bool
Draw closed polygon. [Requires: active graphic context.] [Affected by: plot/fill mode.] Draws closed polygon, as defined by list of N vertices (Vertex0 .. VertexN), using current plot & fill mode. (Note: open vertex list expected.) |
◄ plot_disable | query_border ►
winternal !! query_border () → Rect
Get system window border. [Requires: active winsession.] Returns current window border (as [LeftTopInset : RightBottomInset]). |
[ Graphic ]
graphics !! rect (Left_Top: Point, Right_Bottom: Point) → Bool
Draw rectangle. [Requires: active graphic context.] [Affected by: plot/fill mode.] Draws rectange bound by [Left_Top : Right_Bottom]; with current plot & fill mode. |
◄ query_border | reloc_window ►
winternal !! reloc_window (Win: Window, Left_Top: Point, Width_Height: Point) → ()
Set window location & extent. [Requires: active winsession.] Sets screen region of window Win to (Left_Top : Right_Bottom). |
◄ rect | rename_window ►
winternal !! rename_window (Win: Window, Title: String) → ()
Set window caption. [Requires: active winsession.] Sets caption of window Win to Title. |
◄ reloc_window | round_rect ►
[ Graphic ]
graphics !! round_rect (Left_Top: Point, Right_Bottom: Point, CornerOff: Point) → Bool
Draw rectangle (with elliptical corners). [Requires: active graphic context.] [Affected by: plot/fill mode.] Draws rectange bound by [Left_Top : Right_Bottom] with elliptical corners (by CornerOff); with current plot & fill mode. |
◄ rename_window | show_metadoc ►
[ MetaDoc ]
metadoc !! show_metadoc (Document: MetaDoc) → ()
Metadocument drawing. Draw meta document contents to currect graphics context ("raw mode"). |
◄ round_rect | sleep ►
winternal !! sleep (Interval: Int) → Int
Sleep for a while. [Requires: active winsession.] Sleep for an Interval milliseconds (returning Interval). |
◄ show_metadoc | text ►
[ Graphic ]
graphics !! text (Text: String) → Bool
Draw text string. [Requires: active graphic context.] [Affected by: text mode/origin.] [Affects: text origin.] Outputs string Text at current text origin (advancing it) with current text mode. |
graphics !! text_box (AlignFlags: Int, LeftTop: Point, RightBottom: Point, @Core: Any) → Any
Text box wrapper. [Requires: active graphic context.] Output Core, with clippinng and relative alignment (as by AlignFlags) to [LeftTop : RightBottom] rectangle. |
◄ text | text_metrics ►
graphics !! text_metrics (MetricsList: Mutable, OutFlag: Bool, @Core: Any) → Any
Text metrics wrapper. [Requires: active graphic context.] Evaluates Core, assigning list [TotalWidth MaxAscent MaxDescent MaxLeading] to MetricsList. (If OutFlag is true, actual text output is suppressed in Core.) |
[ Graphic ]
graphics !! text_org (Origin: Point) → Bool
Set text origin. [Requires: active graphic context.] [Affects: text origin.] Sets current text origin to Origin. |
◄ text_metrics | timer_control ►
winternal !! timer_control (Win: Window, TimerID: Int, Interval: Int) → Int
Enable, disable or change window timer. [Requires: active winsession.] Set timer TimerID for Win to interval Interval milliseconds (repeatedly). (If Interval is 0, timer TimerID is stopped.) (If TimerID is < 0, new timer is allocated.) As result, new timer ID (wich may change) is returned. |
◄ text_org | timer_info ►
winternal !! timer_info ([TimerID: Int]) → Int
Get info about timer. [Requires: active winsession.] If TimerID is specified, returns current delay for timer TimerID. (Returns total number of active timers otherwise.) |
◄ timer_control | unichar ►
[ Graphic ]
graphics !! unichar (Code: Int) → Bool
Draw single character. [Requires: active graphic context.] [Affected by: text mode/origin.] [Affects: text origin.] Outputs character with ASCII/Unicode Code at current text origin (advancing it) with current text mode. |
◄ timer_info | vec_add ►
[ Graphic ]
graphics !! vec_add (VecA: Point, VecB: Point) → Point
Vector addition. Addition of integer vectors VecA and VecB (for VecA = (Ax, Ay) and VecB = (Bx, By) returns vector (Ax+Bx, Ay+By)). |
graphics !! vec_eq (VecA: Point, VecB: Point) → Bool
Vector equality. Check integer vectors VecA and VecB for equality (for VecA = (Ax, Ay) and VecB = (Bx, By) returns (Ax == Bx && Ay == By)). |
graphics !! vec_ne (VecA: Point, VecB: Point) → Bool
Vector inequality. Check integer vectors VecA and VecB for inequality (for VecA = (Ax, Ay) and VecB = (Bx, By) returns (Ax <> Bx || Ay <> By)). |
[ Graphic ]
graphics !! vec_neg (VecA: Point) → Point
Vector negation. Negation of integer vector VecA (for VecA = (Ax, Ay) returns vector (-Ax, -Ay)). |
[ Graphic ]
graphics !! vec_scale (F: Float, VecA: Point) → Point
Vector scaling. Scale integer vector VecA by factor F (for VecA = (Ax, Ay) returns vector (Ax*F, Ay*F)). |
[ Graphic ]
graphics !! vec_sub (VecA: Point, VecB: Point) → Point
Vector subtraction. Subtraction of integer vectors VecA and VecB (for VecA = (Ax, Ay) and VecB = (Bx, By) returns vector (Ax-Bx, Ay-By)). |
[ Graphic ]
graphics !! wedge (Left_Top: Point, Right_Bottom: Point, StartRay: Point, EndRay: Point) → Bool
Draw elliptical wedge. [Requires: active graphic context.] [Affected by: plot/fill mode.] Draws elliptical wedge in [Left_Top : Right_Bottom] from StartRay to EndRay with current plot & fill mode. (Note: both StartRay and EndRay are defined relative to center of ellipse.) |
◄ vec_sub | windows_loop ►
winternal !! windows_loop (WidgetRef: Mutable, @Body: Any) → Any
Window iterator. [Requires: active winsession.] Evaluate Body for all active session windows (as accessible through WidgetRef). |
◄ wedge | with_align_center ►
metadoc !! with_align_center (@Core: Any) → Any
Central paragraph alignment wrapper. Set central paragraph alignment for evaluation of Core. |
◄ windows_loop | with_align_full ►
metadoc !! with_align_full (@Core: Any) → Any
Full paragraph alignment wrapper. Set full-width paragraph alignment for evaluation of Core. |
◄ with_align_center | with_align_left ►
metadoc !! with_align_left (@Core: Any) → Any
Left paragraph alignment wrapper. Set left paragraph alignment for evaluation of Core. |
◄ with_align_full | with_align_right ►
metadoc !! with_align_right (@Core: Any) → Any
Right paragraph alignment wrapper. Set right paragraph alignment for evaluation of Core. |
◄ with_align_left | with_debug ►
graphics !! with_debug (Supress: Bool, @Core: Any) → Any
Graphic debugging wrapper. [Requires: active graphic context.] Evaluates Core (with graphic operations logging to stdlog). |
◄ with_align_right | with_def_format ►
metadoc !! with_def_format (@Core: Any) → Any
Default paragraph format wrapper. Define all paragraph attributes for Core according to current font settings. |
◄ with_debug | with_hort_ext ►
metadoc !! with_hort_ext (Left: Int, Right: Int, First: Int, @Core: Any) → Any
Paragraph horizontal "external" values definition wrapper. Set left (Left), right (Right) and first line (First) paragraphs offsets for evaluation of Core. |
◄ with_def_format | with_hort_int ►
metadoc !! with_hort_int (WGap: Int, SGap: Int, @Core: Any) → Any
Paragraph horizontal "internal" values definition wrapper. Set minimum word interval (WGap) and sentence interval (SGap) in paragraphs for evaluation of Core. |
◄ with_hort_ext | with_image ►
graphics !! with_image (Image: Image, @Core: Any) → Any
Image output wrapper. [Requires: active graphic context.] Evaluates Core, with Image as an active graphic output context. |
◄ with_hort_int | with_metadoc ►
metadoc !! with_metadoc (Document: MetaDoc, @Core) → ()
Metadocument initialiser. Initialize meta document Document, evaluating Core. |
◄ with_image | with_para_clip ►
metadoc !! with_para_clip (@Core: Any) → Any
Clip area wrapper. Define clipping area for for evaluation of Core. |
◄ with_metadoc | with_vert_ext ►
metadoc !! with_vert_ext (Above: Int, Below: Int, @Core: Any) → Any
Paragraph vertical "external" values definition wrapper. Set intervals above (Above) and below (Below) paragraphs for evaluation of Core. |
◄ with_para_clip | with_vert_int ►
metadoc !! with_vert_int (Ascent: Int, Descent: Int, Leading: Int, @Core: Any) → Any
Paragraph vertical "internal" values definition wrapper. Set paragraphs ascent (Ascent), descent (Descent) and leading (Leading) for evaluation of Core. |
◄ with_vert_ext | with_window ►
[ Windows | Internal | Wrapper ]
winternal !! with_window (Win: Window, @Body: Any) → Any
Window output wrapper. [Requires: active winsession.] Evaluates Body in display context of window Win. |
◄ with_vert_int |