summaryrefslogtreecommitdiff
path: root/docs/api/plugin.rst
blob: 4e554b3355c048dc88d3262bf7d4c5e12a5a8c0e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
cmd2.plugin
===========

.. autoclass:: cmd2.plugin.PostparsingData
    :members:

    .. attribute:: stop

      Request the command loop terminate by setting ``True``

    .. attribute:: statement

      The :class:`~cmd2.Statement` object parsed from user input


.. autoclass:: cmd2.plugin.PrecommandData
    :members:

    .. attribute:: statement

      The :class:`~cmd2.Statement` object parsed from user input


.. autoclass:: cmd2.plugin.PostcommandData
    :members:

    .. attribute:: stop

      Request the command loop terminate by setting ``True``

    .. attribute:: statement

      The :class:`~cmd2.Statement` object parsed from user input


.. autoclass:: cmd2.plugin.CommandFinalizationData
    :members:

    .. attribute:: stop

      Request the command loop terminate by setting ``True``

    .. attribute:: statement

      The :class:`~cmd2.Statement` object parsed from user input