diff options
Diffstat (limited to 'docs/api/plugin.rst')
-rw-r--r-- | docs/api/plugin.rst | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/api/plugin.rst b/docs/api/plugin.rst new file mode 100644 index 00000000..4e554b33 --- /dev/null +++ b/docs/api/plugin.rst @@ -0,0 +1,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 |