Skip to main content

core.titleview

local titleview = require "core.titleview"

__index​

(field) __index: core.object

Base class providing OOP functionality for Lua. All classes in Pragtical inherit from Object.

capture_text_input​

(field) capture_text_input: boolean?

Receive text input while floating without taking focus

context​

(field) context: 'application'|'session'

current_scale​

(field) current_scale: number

cursor​

(field) cursor: 'arrow'|'hand'|'ibeam'|'sizeh'|'sizenesw'...(+2)

floating​

(field) floating: boolean

Whether the view uses floating placement

floating_closing​

(field) floating_closing: boolean?

Whether input is disabled while a closing slide runs

floating_destination​

(field) floating_destination: (core.view.position)?

Settled position retained during a slide

floating_gesture​

(field) floating_gesture: (core.view.floating_gesture)?

Active pointer drag or resize

floating_options​

(field) floating_options: (core.view.floating_options)?

Placement ownership and input policy

floating_position​

(field) floating_position: (core.view.position)?

Persistent interpolation state for a slide

floating_previous_focus​

(field) floating_previous_focus: (core.view)?

Focus target to restore when hiding

floating_transition​

(field) floating_transition: (core.view.floating_transition)?

Active slide and callback

floating_visible​

(field) floating_visible: boolean?

Whether the view is registered, including closing slides

h_scrollbar​

(field) h_scrollbar: core.scrollbar

Scrollable viewport indicator with draggable thumb. Supports both vertical and horizontal orientation with configurable alignment. Uses a "normal" coordinate system internally that treats all scrollbars as vertical-end-aligned, then transforms to the actual orientation/alignment.

hit_test_bounds​

(field) hit_test_bounds: table<string, number>?

Last supplied native geometry, including the interactive rectangle

hit_test_enabled​

(field) hit_test_enabled: boolean?

Whether native window hit testing is installed

hovered_item​

(field) hovered_item: table

hovered_scrollbar​

(field) hovered_scrollbar: boolean

mouse_selecting​

(field) mouse_selecting: unknown

position​

(field) position: core.view.position

scroll​

(field) scroll: core.view.scroll

scrollable​

(field) scrollable: boolean

size​

(field) size: core.view.position

super​

(field) super: core.view

Base view.

v_scrollbar​

(field) v_scrollbar: core.scrollbar

Scrollable viewport indicator with draggable thumb. Supports both vertical and horizontal orientation with configurable alignment. Uses a "normal" coordinate system internally that treats all scrollbars as vertical-end-aligned, then transforms to the actual orientation/alignment.

visible​

(field) visible: boolean

Whether built-in window decorations are shown

from_state​

function core.view.from_state(state: table)
  -> view: (core.view)?

Create and initialize a new view instance from a previously saved state.

This function is called when restoring workspace/session state. Implementations are responsible for:

  • creating the view instance
  • applying any persisted state

If loading the instance failed nil will be returned.

@return view: (core.view)?

__call​

(method) core.object:__call(...any)
  -> obj: core.object

Metamethod allowing class to be called like a constructor. Enables syntax: local obj = MyClass(args) instead of MyClass:new(args) Automatically creates instance and calls new() with provided arguments.

@return obj: core.object — The new instance of the class

__tostring​

(method) core.titleview:__tostring()
  -> string

bring_to_front​

(method) core.view:bring_to_front()
  -> view: core.view

Raise a shown floating view and its owned popups above the other floating views.

@return view: core.view — This view, for chaining

clamp_scroll_position​

(method) core.view:clamp_scroll_position()

Clamp scroll position to valid range (0 to max scrollable size). Called automatically by update(). Override get_scrollable_size() to customize.

configure_hit_test​

(method) core.titleview:configure_hit_test(borderless: boolean)

Install native drag/resize regions, excluding the embedded menu from dragging. Unchanged geometry does not reinstall the native callback.

@param borderless: boolean — Whether built-in decorations are active

draw​

(method) core.titleview:draw()

Draw the shared title/menu row and synchronize its final laid-out native bounds.

draw_background​

(method) core.view:draw_background(color: renderer.color)

Draw a solid background color for the entire view. Commonly called at the start of draw() methods.

@param color: renderer.color — Array of bytes that represents a color used by the rendering functions.

draw_scrollbar​

(method) core.view:draw_scrollbar()

Draw the view's scrollbars. Commonly called at the end of draw() methods.

draw_window_controls​

(method) core.titleview:draw_window_controls()

Draw the minimize, maximize/restore, and close controls.

draw_window_title​

(method) core.titleview:draw_window_title()

Draw the logo, separate the embedded menu, and clip the remaining title space.

each_control_item​

(method) core.titleview:each_control_item()
  -> iterator: fun():table, number, number, number, number

Iterate window controls with their glyph rectangles in screen coordinates.

@return iterator: fun():table, number, number, number, number — Control, x, y, width, height

extend​

(method) core.object:extend()
  -> cls: core.object

Create a new class that inherits from this one. Returns a new class with this class as its parent. Example: local MyClass = Object:extend()

@return cls: core.object — The new class table

extends​

(method) core.object:extends(T: any)
  -> extends: boolean

Check if object inherits from the given type (inheritance-aware). Use this to check class hierarchy. Example: view:extends(View) returns true for View and all subclasses

@param T: any — Class to check inheritance from

@return extends: boolean — True if object is T or inherits from T

get_content_bounds​

(method) core.view:get_content_bounds()
  -> x1: number
  2. y1: number
  3. x2: number
  4. y2: number

Get the content bounds in content coordinates (accounting for scroll).

@return x1: number — Left edge

@return y1: number — Top edge

@return x2: number — Right edge

@return y2: number — Bottom edge

get_content_offset​

(method) core.view:get_content_offset()
  -> x: number
  2. y: number

Get the top-left corner of content area in screen coordinates. Accounts for scroll offset. Use for drawing content at correct position.

@return x: number — Screen x coordinate

@return y: number — Screen y coordinate

get_floating_bounds​

(method) core.view:get_floating_bounds()
  -> x: number
  2. y: number
  3. w: number
  4. h: number

Get the popup's outer rectangle in screen coordinates, including borders. Override together with set_floating_bounds() for composite views.

@return x: number — Screen x coordinate

@return y: number — Screen y coordinate

@return w: number — Outer width in pixels

@return h: number — Outer height in pixels

get_floating_drag_region​

(method) core.view:get_floating_drag_region()
  -> x: number?
  2. y: number?
  3. w: number?
  4. h: number?

Get the screen rectangle where a floating view can be dragged. Override to restrict dragging to a header; defaults to the full popup bounds.

@return x: number? — Screen x coordinate, or nil to disable dragging

@return y: number? — Screen y coordinate

@return w: number? — Region width

@return h: number? — Region height

get_focus_target​

(method) core.titleview:get_focus_target()
  -> target: nil

Preserve document focus when interacting with title controls or embedded menus.

@return target: nil — Title chrome never takes keyboard focus

get_h_scrollable_size​

(method) core.view:get_h_scrollable_size()
  -> width: number

Get the total scrollable width of the view's content. Used by horizontal scrollbar.

@return width: number — Width in pixels (default: 0, no horizontal scroll)

get_menu_bounds​

(method) core.titleview:get_menu_bounds()
  -> x: number
  2. y: number
  3. width: number
  4. height: number

Get the menu/title area between the application logo and window controls.

@return x: number — Screen x coordinate after the logo

@return y: number — Screen y coordinate at the title bar's top

@return width: number — Available width before the controls

@return height: number — Title bar height

get_module​

(method) core.view:get_module()
  -> path: string?

Returns the module path of this view.

This method resolves the Lua module name that loaded the concrete view class (for example "core.view").

If the view class cannot be associated with any loaded module, nil is returned.

@return path: string?

get_name​

(method) core.view:get_name()
  -> name: string

Get the name displayed in the view's tab. Override to show document name, file path, etc.

@return name: string

get_scrollable_size​

(method) core.view:get_scrollable_size()
  -> height: number

Get the total scrollable height of the view's content. Used by scrollbar to calculate thumb size and position.

@return height: number — Height in pixels (default: infinite)

get_state​

(method) core.view:get_state()
  -> state: table?

Serialize this view into a persistable state table.

This method is called when the editor is saving workspace/session state. The returned table must contain only plain Lua data (no functions, userdata, metatables, or cyclic references).

Returning nil indicates that this view should NOT be restored when reloading the workspace.

@return state: table?

hide_floating​

(method) core.view:hide_floating(options?: core.view.floating_transition)
  -> view: core.view

Hide the floating view, close owned popups, cancel input, and restore focus. A closing slide delays removal while the view immediately stops receiving input. Disabled transitions remove the view and run the completion callback immediately.

@param options?: core.view.floating_transition — Optional closing slide (to) and callback

@return view: core.view — This view, for chaining

hit_test​

(method) core.view:hit_test(x: number, y: number)
  -> inside: boolean

Check whether a screen point lies inside the view's outer rectangle. Override for custom shapes or composites with additional hit regions.

@param x: number — Screen x coordinate

@param y: number — Screen y coordinate

@return inside: boolean — Whether the view contains the point

is​

(method) core.object:is(T: any)
  -> is_exact: boolean

Check if object is exactly of the given type (no inheritance check). Use this for strict type matching. Example: view:is(DocView) returns true only if view is a DocView, not a subclass

@param T: any — Class to check against

@return is_exact: boolean — True if object is exactly type T

is_class_of​

(method) core.object:is_class_of(T: any)
  -> is_instance: boolean

Check if the given object is exactly an instance of this class. Inverse of is() - checks if T is an instance of self. Example: DocView:is_class_of(obj) checks if obj is exactly a DocView

@param T: any — Object to check

@return is_instance: boolean — True if T is exactly an instance of this class

is_extended_by​

(method) core.object:is_extended_by(T: any)
  -> is_extended: boolean

Check if the given object/class inherits from this class. Inverse of extends() - checks if T is a subclass of self. Example: View:is_extended_by(DocView) checks if DocView inherits from View

@param T: any — Object or class to check

@return is_extended: boolean — True if T inherits from this class

is_floating_owner_visible​

(method) core.view:is_floating_owner_visible()
  -> visible: boolean?

Check whether floating popups owned by this view should remain visible. Docked owners must be active in their node; container children follow their parent. Override for composites with their own visibility rules.

@return visible: boolean? — Falsy when the owner is hidden or its tab is inactive

move_towards​

(method) core.view:move_towards(t: table, k: string|number, dest: number, rate?: number, name?: string)

Smoothly animate a value towards a destination. Use this for animations instead of direct assignment.

@param t: table — Table containing the value

@param k: string|number — Key in table

@param dest: number — Target value

@param rate?: number — Animation speed (0-1, default 0.5, higher = faster)

@param name?: string — Transition name (for config.disabled_transitions)

new​

(method) core.titleview:new()

Initialize built-in window decorations.

on_file_dropped​

(method) core.view:on_file_dropped(filename: string, x: number, y: number)
  -> consumed: boolean

Handle file drop events (drag and drop from OS). Override to handle dropped files. Return true to consume event.

@param filename: string — Absolute path to dropped file

@param x: number — Screen x where file was dropped

@param y: number — Screen y where file was dropped

@return consumed: boolean — True to consume event, false to propagate

on_floating_dismiss​

(method) core.view:on_floating_dismiss(reason: "escape"|"focuslost"|"outside")

Handle a dismissal requested by Escape, an outside click, or window focus loss. The default implementation hides the view immediately; override for custom handling.

reason:
    | "escape"
    | "outside"
    | "focuslost"

@param reason: "escape"|"focuslost"|"outside" — Event that requested dismissal

on_floating_visibility_changed​

(method) core.view:on_floating_visibility_changed(visible: boolean)

Called when showing a floating view or completing its removal. Override to synchronize widget visibility or clear popup controller state.

@param visible: boolean — True on show, false when removal completes

on_ime_text_editing​

(method) core.view:on_ime_text_editing(text: string, start: number, length: number)

Handle IME (Input Method Editor) text composition events. Override for IME support in text editors. Called during composition.

@param text: string — Composition text being edited

@param start: number — Start position of selection within composition

@param length: number — Length of selection within composition

on_key_pressed​

(method) core.view:on_key_pressed(stroke: string, ...any)
  -> consumed: boolean?

Handle a floating view's keyboard input before command dispatch. Override and return true to consume the normalized key binding.

@param stroke: string — Normalized key binding, such as "ctrl+return"

@param: any — Additional arguments forwarded by the keyboard handler

@return consumed: boolean? — Whether the event was handled

on_mouse_capture_lost​

(method) core.view:on_mouse_capture_lost()

Cancel pointer gestures when RootView releases mouse capture without a click. Clears floating dragging, text selection, scrollbar dragging, and hover state. Override to clear any additional subclass gesture state.

on_mouse_left​

(method) core.titleview:on_mouse_left()

Clear window-control and embedded-menu hover when leaving the title bar.

on_mouse_moved​

(method) core.titleview:on_mouse_moved(px: number, py: number, ...any)

Update embedded-menu hover and window-control hover without taking focus.

@param px: number — Screen x coordinate

@param py: number — Screen y coordinate

@param: any — Pointer movement deltas

on_mouse_pressed​

(method) core.titleview:on_mouse_pressed(button: 'left'|'right', x: number, y: number, clicks: integer)
  -> consumed: boolean?

Route clicks on embedded labels to the application menu.

button:
    | 'left'
    | 'right'

@param button: 'left'|'right' — Pressed button

@param x: number — Screen x coordinate

@param y: number — Screen y coordinate

@param clicks: integer — Consecutive click count

@return consumed: boolean? — Whether an embedded menu consumed the press

on_mouse_released​

(method) core.titleview:on_mouse_released(button: 'left'|'right', x: number, y: number)

Complete a menu interaction or activate the hovered window control.

button:
    | 'left'
    | 'right'

@param button: 'left'|'right' — Released button

@param x: number — Screen x coordinate

@param y: number — Screen y coordinate

on_mouse_wheel​

(method) core.view:on_mouse_wheel(y: number, x: number)
  -> consumed: boolean?

Handle mouse wheel scroll events. Override for custom scroll behavior. Base implementation does nothing.

@param y: number — Vertical scroll delta; positive is "up"

@param x: number — Horizontal scroll delta; positive is "left"

@return consumed: boolean? — True to consume event

on_scale_change​

(method) core.titleview:on_scale_change()

Refresh the native title geometry after an interface scale change.

on_text_input​

(method) core.view:on_text_input(text: string)

Handle text input events (typing, IME composition). Override for text editing. Called after IME composition completes.

@param text: string — Input text (may be multiple characters)

on_touch_moved​

(method) core.view:on_touch_moved(x: number, y: number, dx: number, dy: number, i: number)

Handle touch move events (touchscreen/trackpad gestures). Override for touch-specific behavior. Base implementation handles scrolling.

@param x: number — Current touch x coordinate

@param y: number — Current touch y coordinate

@param dx: number — Delta x since last position

@param dy: number — Delta y since last position

@param i: number — Touch finger/pointer index

owns_view​

(method) core.view:owns_view(view?: core.view)
  -> owned: boolean

Check whether a view is this view or belongs to it through a container or owner. Follows parent, subparent, and floating owner links while guarding against cycles.

@param view?: core.view — Candidate view

@return owned: boolean — Whether the candidate belongs to this view

scrollbar_dragging​

(method) core.view:scrollbar_dragging()
  -> dragging: boolean

Check if user is currently dragging either scrollbar.

@return dragging: boolean — True if scrollbar drag is in progress

scrollbar_hovering​

(method) core.view:scrollbar_hovering()
  -> hovering: boolean

Check if mouse is hovering over either scrollbar track.

@return hovering: boolean — True if mouse is over scrollbar

scrollbar_overlaps_point​

(method) core.view:scrollbar_overlaps_point(x: number, y: number)
  -> overlaps: boolean

Check if a screen point overlaps either scrollbar. Useful for determining cursor style or handling clicks.

@param x: number — Screen x coordinate

@param y: number — Screen y coordinate

@return overlaps: boolean — True if point is over vertical or horizontal scrollbar

set_floating​

(method) core.view:set_floating(enabled: boolean, options?: core.view.floating_options)
  -> view: core.view

Enable or disable floating placement and configure popup input and ownership. Call show_floating() to show the view after enabling this mode. Detach it from its node or parent container before showing. Disabling hides it.

@param enabled: boolean — Whether the view should use floating placement

@param options?: core.view.floating_options — Options merged with existing ones when enabling

@return view: core.view — This view, for chaining

set_floating_bounds​

(method) core.view:set_floating_bounds(x: number, y: number, w: number, h: number)

Set the popup's outer rectangle when RootView places, drags, or resizes it. Override for composites that need to update child layout or account for borders.

@param x: number — Screen x coordinate

@param y: number — Screen y coordinate

@param w: number — Outer width in pixels

@param h: number — Outer height in pixels

show_floating​

(method) core.view:show_floating(options?: core.view.floating_transition)
  -> view: core.view

Show or raise the view in RootView's floating layer and apply its focus policy. Requires a view detached from its node and parent container. Reopening cancels a pending close and its completion callback. Disabled transitions apply placement and run the completion callback immediately.

@param options?: core.view.floating_transition — Optional opening slide (from) and callback

@return view: core.view — This view, for chaining

supports_text_input​

(method) core.view:supports_text_input()
  -> boolean

Whether this view accepts text input (enables IME). Override and return true for text editors and input fields.

try_close​

(method) core.view:try_close(do_close: function)

Called when view is requested to close (e.g., tab close button). Override to show confirmation dialogs for unsaved changes. Example: core.command_view:enter("Save?", \{submit = do_close\})

@param do_close: function — Call this function to actually close the view

update​

(method) core.titleview:update()

Keep the title height and maximize/restore button synchronized with the window.

update_floating​

(method) core.view:update_floating()

Update anchor placement or advance an opening or closing slide. RootView calls this before update() for each shown floating view. Completes removal and invokes the transition callback when a slide finishes.

update_menu_bounds​

(method) core.titleview:update_menu_bounds()

Supply application-menu placement while built-in decorations are visible. MenuView's node remains responsible for updating its animation once per frame.

update_scrollbar​

(method) core.view:update_scrollbar()

Update scrollbar positions and sizes. Called automatically by update(). Rarely needs to be called manually.