ExSNI v0.2.9

View Source ExSni.Menu.Item (ExSNI v0.2.9)

Link to this section Summary

Types

dbus_menu_item()
dbus_menu_properties()
dbus_variant()
id()
item_type()
layout()
t()
toggle_state()
toggle_type()

Functions

checkbox(label \\ "")
disable(item)
enable(item)
find_item(item, id)
get_changed_properties(current, other)
get_changed_properties(current, other, list)
get_dbus_changed_properties(current, other, opts \\ [])
get_layout(menu_item, depth, properties)
hidden(item)
menu(children \\ [])
radio(label \\ "")
root(children \\ [])
separator()
set_callbacks(item, callbacks)
set_checked(item, value \\ true)
set_enabled(item, value)
set_id(item, id)

WARNING: Always use unique IDs across the entire tree. If you set the same ID for a node and any of its descendants, most menu hosts (i.e. libdbusmenu) will recurse indefinitely when attempting to build the list of IDs to request the layout for; which will most likely result in a system-wide crash/hang.

set_label(item, label)
set_uid(item, uid)
set_visible(item, value)
standard(label \\ "")
toggle_checked(item)
toggle_enabled(item)
toggle_visible(item)
visible(item)

Link to this section Types

Link to this type

dbus_menu_item()

View Source

Specs

dbus_menu_item() :: {integer(), dbus_menu_properties(), [dbus_menu_item()]}
Link to this type

dbus_menu_properties()

View Source

Specs

dbus_menu_properties() :: [{String.t(), dbus_variant()}]
Link to this type

dbus_variant()

View Source

Specs

dbus_variant() :: {:dbus_variant, any(), any()}
Link to this type

id()

View Source

Specs

id() :: non_neg_integer()
Link to this type

item_type()

View Source

Specs

item_type() :: :separator | :root | :standard | :checkbox | :radio | :menu
Link to this type

layout()

View Source

Specs

layout() :: {:dbus_variant, {:struct, list()}, dbus_menu_item()}
Link to this type

t()

View Source

Specs

t() :: %ExSni.Menu.Item{
  callbacks: [ExSni.Menu.callback()],
  checked: boolean(),
  children: [t()],
  enabled: boolean(),
  icon: nil | String.t() | ExSni.Icon.Info.t(),
  id: id(),
  label: String.t(),
  type: item_type(),
  uid: String.t(),
  visible: boolean()
}
Link to this type

toggle_state()

View Source

Specs

toggle_state() :: nil | :on | :off
Link to this type

toggle_type()

View Source

Specs

toggle_type() :: nil | :checkmark | :radio

Link to this section Functions

Link to this function

checkbox(label \\ "")

View Source
Link to this function

disable(item)

View Source

Specs

disable(t()) :: t()
Link to this function

enable(item)

View Source

Specs

enable(t()) :: t()
Link to this function

find_item(item, id)

View Source

Specs

find_item(t(), id()) :: nil | t()
Link to this function

get_changed_properties(current, other)

View Source
Link to this function

get_changed_properties(current, other, list)

View Source

Specs

get_changed_properties(current :: t(), other :: t(), properties :: [atom()]) ::
  [atom()]
Link to this function

get_dbus_changed_properties(current, other, opts \\ [])

View Source
Link to this function

get_layout(menu_item, depth, properties)

View Source

Specs

get_layout(t(), integer(), [String.t()]) :: layout()
Link to this function

hidden(item)

View Source

Specs

hidden(t()) :: t()
Link to this function

radio(label \\ "")

View Source
Link to this function

root(children \\ [])

View Source

Specs

root(children :: [t()]) :: t()
Link to this function

separator()

View Source

Specs

separator() :: t()
Link to this function

set_callbacks(item, callbacks)

View Source

Specs

set_callbacks(t(), callbacks :: [ExSni.Menu.callback()]) :: t()
Link to this function

set_checked(item, value \\ true)

View Source

Specs

set_checked(t(), new_state :: boolean()) :: t()
Link to this function

set_enabled(item, value)

View Source

Specs

set_enabled(t(), value :: boolean()) :: t()
Link to this function

set_id(item, id)

View Source

Specs

set_id(t(), id :: id()) :: t()

WARNING: Always use unique IDs across the entire tree. If you set the same ID for a node and any of its descendants, most menu hosts (i.e. libdbusmenu) will recurse indefinitely when attempting to build the list of IDs to request the layout for; which will most likely result in a system-wide crash/hang.

To store custom ID (e.g. "id" attribute), use uid property and set_uid/2

Link to this function

set_label(item, label)

View Source

Specs

set_label(t(), label :: String.t()) :: t()
Link to this function

set_uid(item, uid)

View Source

Specs

set_uid(t(), uid :: String.t()) :: t()
Link to this function

set_visible(item, value)

View Source

Specs

set_visible(t(), value :: boolean()) :: t()
Link to this function

standard(label \\ "")

View Source

Specs

standard(label :: String.t()) :: t()
Link to this function

toggle_checked(item)

View Source

Specs

toggle_checked(t()) :: t()
Link to this function

toggle_enabled(item)

View Source

Specs

toggle_enabled(t()) :: t()
Link to this function

toggle_visible(item)

View Source

Specs

toggle_visible(t()) :: t()
Link to this function

visible(item)

View Source

Specs

visible(t()) :: t()