Skip to main content

core.contextmenu

A context menu.

local contextmenu = require "core.contextmenu"

DIVIDER​

(field) DIVIDER: table

A unique value representing the divider in a context menu.

__index​

(field) __index: core.object

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

current_scale​

(field) current_scale: number

height​

(field) height: integer

items​

(field) items: table

move_towards​

(field) move_towards: fun(self: table, k: string, dest: number, rate?: number, name?: string)

position​

(field) position: core.view.position

selected​

(field) selected: number

show_context_menu​

(field) show_context_menu: boolean

super​

(field) super: core.object

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

core.contextmenu.item​

An item in the context menu.

command​

(field) command: string|fun()

info​

(field) info: string|nil

If provided, this text is displayed on the right side of the menu.

text​

(field) text: string

core.contextmenu.itemset​

A list of items with the same predicate.

items​

(field) items: core.contextmenu.item[]

predicate​

(field) predicate: string|core.object|fun(...any):boolean, ...unknown

A predicate is a string, an Object or a function, that is used to determine whether a command should be executed.

If the predicate is a string, it is resolved into an Object via require() and checked against the active view with Object:extends(). For example, "core.docview" will match any view that inherits from DocView. A ! can be appended to the predicate to strictly match the current view via Object:is(), instead of matching any view that inherits the predicate.

If the predicate is a table, it is checked against the active view with Object:extends(). Strict matching via Object:is() is not available.

If the predicate is a function, it must behave like a predicate function.

__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 — The new instance of the class

__tostring​

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

call_selected_item​

(method) core.contextmenu:call_selected_item()

Hides the context menu and performs the command if an item is selected.

draw​

(method) core.contextmenu:draw()

Draws the context menu.

This wraps ContextMenu:draw_context_menu().

draw_context_menu​

(method) core.contextmenu:draw_context_menu()

Draws the context menu.

each_item​

(method) core.contextmenu:each_item()
  -> fun():number, core.contextmenu.item, number, number, number, number

Returns an iterator that iterates over each context menu item and their dimensions.

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 — 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 — Class to check inheritance from

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

focus_next​

(method) core.contextmenu:focus_next()

Selects the next item.

focus_previous​

(method) core.contextmenu:focus_previous()

Selects the the previous item.

get_item_selected​

(method) core.contextmenu:get_item_selected()
  -> core.contextmenu.item|nil

Gets the currently selected item.

hide​

(method) core.contextmenu:hide()

Hides the context menu.

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 — Class to check against

@return is_exact — 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 — Object to check

@return is_instance — 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 — Object or class to check

@return is_extended — True if T inherits from this class

new​

(method) core.contextmenu:new()

Creates a new context menu.

on_mouse_moved​

(method) core.contextmenu:on_mouse_moved(px: any, py: any)
  -> boolean

Event handler for mouse movements.

@return — true if the event is caught.

on_mouse_pressed​

(method) core.contextmenu:on_mouse_pressed(button: 'left'|'right', px: number, py: number, clicks: number)
  -> boolean

Event handler for mouse press.

@return — true if the event is caught.

button:
    | 'left'
    | 'right'

on_selected​

(method) core.contextmenu:on_selected(item: core.contextmenu.item)

Event handler for when the selection is confirmed.

register​

(method) core.contextmenu:register(predicate: string|core.object|fun(...any):boolean, ...unknown, items: core.contextmenu.item[])

Registers a list of items into the context menu with a predicate.

show​

(method) core.contextmenu:show(x: number, y: number)
  -> boolean

Shows the context menu.

@return — If true, the context menu is shown.

update​

(method) core.contextmenu:update()

Event handler for content update.