dmui.dsl.Submenu Class Reference

Inheritance diagram for dmui.dsl.Submenu:

Collaboration diagram for dmui.dsl.Submenu:

Public Member Functions
	__init__ (self, str clazz, str cpp_name, list[str] arg_template, str description, list[Menu] children, Optional[str] title=None, Optional[str] name=None, Optional[str] available_when=None)
	visit (self, visitor)
Public Member Functions inherited from dmui.dsl.Menu
	__init__ (self, str clazz, str cpp_name, list[str] arg_template, Optional[str] description, Optional[str] name=None, Optional[str] title=None, Optional[str] available_when=None)
	template_args (self)

Public Attributes
	children = children
Public Attributes inherited from dmui.dsl.Menu
	cpp_name = cpp_name
	clazz = clazz
	title = name
	name = title
	arg_template = arg_template
	description = description
	available_when = None

Detailed Description

A menu capable of containing others.

:param clazz: The C++ class to use for this menu item.
:param cpp_name: The variable name to use when emitting C++ code.
:param arg_template: A list of Python format strings which will be used to
    generate the C++ initializer arguments. At least one of the argumnents
    must be ``%%CHILDREN%%`` which will be replaced by references to the
    children.
:param title: The key in the language map for the header of this menu item
    when it's opened.
:param description: Path to the description of this mode, relative to
    ``docs/menu``
:param children: The menus this submenu selects from.
:param name: The key in the langauge map for the string to be rendered when
    this menu item is presented for selection in a submenu. If None,
    inherited from ``title``. At least one of ``name`` or ``title`` must be
    provided.
:param title: The key in the language map for the header of this menu item
    when it's opened. If None, inherited from ``name``. At least one of
    ``name`` or ``title`` must be provided.
:param available_when: A human-readable description of when this menu item
    is available, if it's only available in certain contexts or when the
    system is in a particular state. A value of None (the default)
    indicates this menu item is always available.

Member Function Documentation

visit()

dmui.dsl.Submenu.visit	(		self,
			visitor )

Reimplemented from dmui.dsl.Menu.

---

The documentation for this class was generated from the following file:

• src/deluge/gui/menu_item/generate/dmui/dsl.py