List

Tree view widget.

class List : Widget (
D
) if (
isProcessible!D
) {}

Constructors

this
this(Widget parent, Data data)

Adds a TreeView to the specified parent.

Members

Aliases

Data
alias Data = D
Undocumented in source.

Functions

applyByTreePath
void applyByTreePath(const(TreePath) tree_path, void delegate(ref const(T) value) dg)
Undocumented in source. Be warned that the author may not have intended to support it.
collapsed
Nullable!bool collapsed(int[] path)
Undocumented in source. Be warned that the author may not have intended to support it.
collapsed
bool collapsed()
Undocumented in source. Be warned that the author may not have intended to support it.
collapsed
void collapsed(bool value)
Undocumented in source. Be warned that the author may not have intended to support it.
collapsed
void collapsed(int[] path, bool value)
Undocumented in source. Be warned that the author may not have intended to support it.
draw
void draw(NanoContext ctx)

Draws this TreeView.

mouseButtonEvent
bool mouseButtonEvent(Vector2i p, MouseButton button, bool down, int modifiers)

The mouse button callback will return true when all three conditions are met:

mouseDragEvent
bool mouseDragEvent(Vector2i p, Vector2i rel, MouseButton button, int modifiers)
Undocumented in source. Be warned that the author may not have intended to support it.
mouseEnterEvent
bool mouseEnterEvent(Vector2i p, bool enter)
Undocumented in source. Be warned that the author may not have intended to support it.
performLayout
void performLayout(NanoContext ctx)
Undocumented in source. Be warned that the author may not have intended to support it.
preferredSize
Vector2i preferredSize(NanoContext ctx)

The preferred size of this TreeView.

scroll
float scroll()

Return the current scroll amount as a value between 0 and 1. 0 means scrolled to the top and 1 to the bottom.

scrollEvent
bool scrollEvent(Vector2i p, Vector2f rel)
Undocumented in source. Be warned that the author may not have intended to support it.
setScroll
void setScroll(float scroll)

Set the scroll amount to a value between 0 and 1. 0 means scrolled to the top and 1 to the bottom.

Imports

Nullable (from std.typecons)
public import std.typecons : Nullable;
Undocumented in source.

Manifest constants

ScrollBarWidth
enum ScrollBarWidth;
Undocumented in source.
modelHasCollapsed
enum modelHasCollapsed;
Undocumented in source.

Properties

data
Data data [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.

Structs

ScrollButtonSize
struct ScrollButtonSize
Undocumented in source.

Variables

_data
Data _data;
Undocumented in source.
_finish_item
size_t _finish_item;
Undocumented in source.
_model
typeof(makeModel(_data)) _model;
Undocumented in source.
_model_changed
bool _model_changed;
Undocumented in source.
_pushed_scroll_btn
bool _pushed_scroll_btn;
Undocumented in source.
_scroll_position
size_t _scroll_position;
Undocumented in source.
_shift
size_t _shift;
Undocumented in source.
_start_item
size_t _start_item;
Undocumented in source.
mPushed
bool mPushed;
Undocumented in source.
mScroll
double mScroll;
Undocumented in source.
onMousePressed
void delegate(MouseButton, ref const(TreePath)) onMousePressed;

Callback that called on mouse clicking

rm
RelativeMeasurer rm;
Undocumented in source.
tree_path
TreePath tree_path;
Undocumented in source.

Inherited Members

From Widget

parent
Widget parent()

Return the parent widget

parent
auto parent()

Return the parent widget

parent
void parent(Widget parent)

Set the parent widget

layout
Layout layout()

Return the used nanogui.layout.Layout generator

layout
auto layout()

Return the used nanogui.layout.Layout generator

layout
void layout(Layout layout)

Set the used nanogui.layout.Layout generator

theme
const(Theme) theme()

Return the nanogui.theme.Theme used to draw this widget

theme
void theme(Theme theme)

Set the nanogui.theme.Theme used to draw this widget

position
Vector2i position()

Return the position relative to the parent widget

position
void position(Vector2i pos)

Set the position relative to the parent widget

absolutePosition
Vector2i absolutePosition()

Return the absolute position on screen

size
Vector2i size()

Return the size of the widget

size
void size(Vector2i size)

set the size of the widget

width
int width()

Return the width of the widget

width
void width(int width)

Set the width of the widget

height
int height()

Return the height of the widget

height
void height(int height)

Set the height of the widget

fixedSize
void fixedSize(Vector2i fixedSize)

Set the fixed size of this widget

fixedSize
Vector2i fixedSize()

Return the fixed size

fixedWidth
int fixedWidth()

Return the fixed width (see fixedSize)

fixedHeight
int fixedHeight()

Return the fixed height (see fixedSize)

fixedWidth
void fixedWidth(int width)

Set the fixed width (see fixedSize)

fixedHeight
void fixedHeight(int height)

Set the fixed height (see fixedSize)

visible
bool visible()

Return whether or not the widget is currently visible (assuming all parents are visible)

visible
void visible(bool visible)

Set whether or not the widget is currently visible (assuming all parents are visible)

visibleRecursive
bool visibleRecursive()

Check if this widget is currently visible, taking parent widgets into account

childCount
int childCount()

Return the number of child widgets

children
auto children()

Return the list of child widgets of the current widget

addChild
void addChild(int index, Widget widget)

Add a child widget to the current widget at the specified index.

addChild
void addChild(Widget widget)

Convenience function which appends a widget at the end

removeChild
void removeChild(int index)

Remove a child widget by index

removeChild
void removeChild(Widget widget)

Remove a child widget by value

childAt
auto childAt(int index)

Retrieves the child at the specific position

childAt
auto childAt(int index)

Retrieves the child at the specific position

childIndex
int childIndex(Widget widget)

Returns the index of a specific child or -1 if not found

add
auto add(Args args)

Variadic shorthand notation to construct and add a child widget

window
Window window()

Walk up the hierarchy and return the parent window

screen
Screen screen()

Walk up the hierarchy and return the parent screen

setId
void setId(string id)

Associate this widget with an ID value (optional)

id
auto id()

Return the ID value associated with this widget, if any

enabled
bool enabled()

Return whether or not this widget is currently enabled

enabled
void enabled(bool enabled)

Set whether or not this widget is currently enabled

focused
bool focused()

Return whether or not this widget is currently focused

focused
void focused(bool focused)

Set whether or not this widget is currently focused

requestFocus
void requestFocus()

Request the focus to be moved to this widget

tooltip
string tooltip()
Undocumented in source. Be warned that the author may not have intended to support it.
tooltip
void tooltip(string tooltip)
Undocumented in source. Be warned that the author may not have intended to support it.
fontSize
int fontSize()

Return current font size. If not set the default of the current theme will be returned

fontSize
void fontSize(int fontSize)

Set the font size of this widget

hasFontSize
bool hasFontSize()

Return whether the font size is explicitly specified for this widget

iconExtraScale
float iconExtraScale()

The amount of extra scaling applied to *icon* fonts. See nanogui.Widget.mIconExtraScale.

iconExtraScale
void iconExtraScale(float scale)

Sets the amount of extra scaling applied to *icon* fonts. See nanogui.Widget.mIconExtraScale.

cursor
Cursor cursor()

Return a pointer to the cursor of the widget

cursor
void cursor(Cursor value)

Set the cursor of the widget

contains
bool contains(Vector2i p)
bool contains(Vector2f p)

Check if the widget contains a certain position

findWidget
Widget findWidget(Vector2i p)

Determine the widget located at the given position value (recursive)

mouseButtonEvent
bool mouseButtonEvent(Vector2i p, MouseButton button, bool down, int modifiers)

Handle a mouse button event (default implementation: propagate to children)

mouseMotionEvent
bool mouseMotionEvent(Vector2i p, Vector2i rel, MouseButton button, int modifiers)

Handle a mouse motion event (default implementation: propagate to children)

mouseDragEvent
bool mouseDragEvent(Vector2i p, Vector2i rel, MouseButton button, int modifiers)

Handle a mouse drag event (default implementation: do nothing)

mouseEnterEvent
bool mouseEnterEvent(Vector2i p, bool enter)

Handle a mouse enter/leave event (default implementation: record this fact, but do nothing)

scrollEvent
bool scrollEvent(Vector2i p, Vector2f rel)

Handle a mouse scroll event (default implementation: propagate to children)

focusEvent
bool focusEvent(bool focused)

Handle a focus change event (default implementation: record the focus status, but do nothing)

keyboardEvent
bool keyboardEvent(int key, int scancode, KeyAction action, int modifiers)

Handle a keyboard event (default implementation: do nothing)

keyboardCharacterEvent
bool keyboardCharacterEvent(dchar codepoint)

Handle text input (UTF-32 format) (default implementation: do nothing)

preferredSize
Vector2i preferredSize(NanoContext ctx)

Compute the preferred size of the widget

preferredSize
Vector2i preferredSize(NanoContext ctx, Widget skipped)

Compute the preferred size of the widget considering its child except skipped one (for example button panel of window)

performLayout
void performLayout(NanoContext ctx)

Invoke the associated layout generator to properly place child widgets, if any

draw
void draw(NanoContext ctx)

Draw the widget (and all child widgets)

~this
~this()

Free all resources used by the widget and any children

icon_scale
float icon_scale()

Convenience definition for subclasses to get the full icon scale for this class of Widget. It simple returns the value mTheme.mIconScale * this.mIconExtraScale.

mParent
Widget mParent;
Undocumented in source.
mTheme
Theme mTheme;
Undocumented in source.
mLayout
Layout mLayout;
Undocumented in source.
mId
string mId;
Undocumented in source.
mPos
Vector2i mPos;
mSize
Vector2i mSize;
mFixedSize
Vector2i mFixedSize;
Undocumented in source.
mChildren
Array!Widget mChildren;
Undocumented in source.
mVisible
bool mVisible;

Whether or not this Widget is currently visible. When a Widget is not currently visible, no time is wasted executing its drawing method.

mEnabled
bool mEnabled;

Whether or not this Widget is currently enabled. Various different kinds of derived types use this to determine whether or not user input will be accepted. For example, when `mEnabled == false`, the state of a CheckBox cannot be changed, or a TextBox will not allow new input.

mFocused
bool mFocused;
mMouseFocus
bool mMouseFocus;
Undocumented in source.
mTooltip
string mTooltip;
Undocumented in source.
mFontSize
int mFontSize;
Undocumented in source.
mIconExtraScale
float mIconExtraScale;

The amount of extra icon scaling used in addition the the theme's default icon font scale. Default value is `1.0`, which implies that icon_scale simply returns the value of nanogui.Theme.mIconScale.

mCursor
Cursor mCursor;
Undocumented in source.

Meta