Skip to main content

core.nagview

local nagview = require "core.nagview"

__index​

(field) __index: core.object

context​

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

current_scale​

(field) current_scale: number

cursor​

(field) cursor: 'arrow'|'hand'|'ibeam'|'sizeh'|'sizev'

dim_alpha​

(field) dim_alpha: integer

force_focus​

(field) force_focus: boolean

h_scrollbar​

(field) h_scrollbar: core.scrollbar

Scrollbar Use Scrollbar:set_size to set the bounding box of the view the scrollbar belongs to. Use Scrollbar:update to update the scrollbar animations. Use Scrollbar:draw to draw the scrollbar. Use Scrollbar:on_mouse_pressed, Scrollbar:on_mouse_released, Scrollbar:on_mouse_moved and Scrollbar:on_mouse_left to react to mouse movements; the scrollbar won't update automatically. Use Scrollbar:set_percent to set the scrollbar location externally.

To manage all the orientations, the scrollbar changes the coordinates system accordingly. The "normal" coordinate system adapts the scrollbar coordinates as if it's always a vertical scrollbar, positioned at the end of the bounding box.

hovered_item​

(field) hovered_item: any

hovered_scrollbar​

(field) hovered_scrollbar: boolean

message​

(field) message: unknown

on_mouse_pressed_root​

(field) on_mouse_pressed_root: unknown

on_selected​

(field) on_selected: unknown

options​

(field) options: unknown

position​

(field) position: core.view.position

queue​

(field) queue: table

scroll​

(field) scroll: core.view.scroll

scrollable​

(field) scrollable: boolean

show_height​

(field) show_height: integer

size​

(field) size: core.view.position

super​

(field) super: core.view

Base view.

target_height​

(field) target_height: integer|unknown

self.target_height is the nagview height needed to display the message and the buttons, excluding the top and bottom padding space.

title​

(field) title: unknown

underline_progress​

(field) underline_progress: integer

v_scrollbar​

(field) v_scrollbar: core.scrollbar

Scrollbar Use Scrollbar:set_size to set the bounding box of the view the scrollbar belongs to. Use Scrollbar:update to update the scrollbar animations. Use Scrollbar:draw to draw the scrollbar. Use Scrollbar:on_mouse_pressed, Scrollbar:on_mouse_released, Scrollbar:on_mouse_moved and Scrollbar:on_mouse_left to react to mouse movements; the scrollbar won't update automatically. Use Scrollbar:set_percent to set the scrollbar location externally.

To manage all the orientations, the scrollbar changes the coordinates system accordingly. The "normal" coordinate system adapts the scrollbar coordinates as if it's always a vertical scrollbar, positioned at the end of the bounding box.

visible​

(field) visible: boolean

__call​

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

Metamethod to allow using the object call as a constructor.

__tostring​

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

Metamethod to get a string representation of an object.

change_hovered​

(method) core.nagview:change_hovered(i: any)

clamp_scroll_position​

(method) core.view:clamp_scroll_position()

dim_window_content​

(method) core.nagview:dim_window_content()

draw​

(method) core.nagview:draw()

draw_background​

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

draw_scrollbar​

(method) core.view:draw_scrollbar()

each_option​

(method) core.nagview:each_option()
  -> fun(...any):...unknown

extend​

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

extends​

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

Check if the object inherits from the given type.

get_buttons_height​

(method) core.nagview:get_buttons_height()
  -> unknown

Buttons height without padding

get_content_bounds​

(method) core.view:get_content_bounds()
  -> number
  2. number
  3. number
  4. number

get_content_offset​

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

get_h_scrollable_size​

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

get_line_height​

(method) core.nagview:get_line_height()
  -> integer

The two methods below are duplicated from DocView

get_line_text_y_offset​

(method) core.nagview:get_line_text_y_offset()
  -> unknown

get_message_height​

(method) core.nagview:get_message_height()
  -> unknown

get_name​

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

get_scrollable_size​

(method) core.nagview:get_scrollable_size()
  -> number

get_target_height​

(method) core.nagview:get_target_height()
  -> number

get_title​

(method) core.nagview:get_title()
  -> unknown

is​

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

Check if the object is strictly of the given type.

is_class_of​

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

Check if the parameter is strictly of the object type.

is_extended_by​

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

Check if the parameter inherits from the object.

move_towards​

(method) core.view:move_towards(t: any, k: any, dest: any, rate: any, name: any)

new​

(method) core.nagview:new()

next​

(method) core.nagview:next()

on_file_dropped​

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

on_ime_text_editing​

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

on_mouse_left​

(method) core.view:on_mouse_left()

on_mouse_moved​

(method) core.nagview:on_mouse_moved(mx: number, my: number, ...any)

on_mouse_pressed​

(method) core.nagview:on_mouse_pressed(button: 'left'|'right', mx: number, my: number, clicks: integer)
  -> boolean

on_mouse_released​

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

on_mouse_wheel​

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

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

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

@return — Capture event

on_scale_change​

(method) core.nagview:on_scale_change(new_scale: number, old_scale: number)

on_text_input​

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

on_touch_moved​

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

scrollbar_dragging​

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

scrollbar_hovering​

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

scrollbar_overlaps_point​

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

show​

(method) core.nagview:show(title: any, message: any, options: any, on_select: any)

supports_text_input​

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

try_close​

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

update​

(method) core.nagview:update()

update_scrollbar​

(method) core.view:update_scrollbar()