Public Member Functions
	__init__ (self, str name, str t, str desc, any default=None)

dict	to_dict (self)

Public Attributes
	default = default

	desc = desc

	name = name

	t = t

Detailed Description

this is used by the UI through the plugin.options() method to list the supported options, and their types, for a plugin.

Definition at line 100 of file plugin_internal.py.

Constructor & Destructor Documentation

◆ init()

__init__	(		self,
		str	name,
		str	t,
		str	desc,
		any	default = None )

:param name: option name
:param t: option type (use "bool", "str", "int", "float", "dict", "list" for the types.)
:param desc: option description
:param default: default value

Definition at line 105 of file plugin_internal.py.

    def __init__(self, name: str, t: str, desc: str, default: any = None):
        """
        :param name: option name
        :param t: option type (use "bool", "str", "int", "float", "dict", "list" for the types.)
        :param desc: option description
        :param default: default value
        """
        self.name = name
        self.t = t
        self.default = default
        self.desc = desc
 

Member Function Documentation

◆ to_dict()

dict to_dict ( self )

Definition at line 117 of file plugin_internal.py.

    def to_dict(self) -> dict:
        return {
            "name": self.name,
            "type": self.t,
            "default": self.default,
            "desc": self.desc,
        }

Here is the call graph for this function:

Member Data Documentation

◆ default

default = default

Definition at line 114 of file plugin_internal.py.

◆ desc

desc = desc

Definition at line 115 of file plugin_internal.py.

◆ name

name = name

Definition at line 112 of file plugin_internal.py.

◆ t

t = t

Definition at line 113 of file plugin_internal.py.

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

src/gulp/plugin_internal.py

Public Member Functions

Public Attributes