Encapsulate all menu related stuff inside Menu.cpp and simplify a few things.

[lyx.git] / src / frontends / Delegates.h

diff --git a/src/frontends/Delegates.h b/src/frontends/Delegates.h
index 1a41771e3dc7b9de264d3a84de4708376bd647ee..96c134bf56b706bf2f9fc152ea3e39f397ae8de8 100644 (file)
--- a/src/frontends/Delegates.h
+++ b/src/frontends/Delegates.h
@@ -30,6 +30,18 @@ public:
        virtual void message(docstring const & msg) = 0;
 
        /// This function is called when some inset dialogs needs to be shown.
+       /** \param name == "bibtex", "citation" etc; an identifier used to
+           launch a particular dialog.
+           \param data is a string representation of the Inset contents.
+           It is often little more than the output from Inset::write.
+           It is passed to, and parsed by, the frontend dialog.
+           Several of these dialogs do not need any data.
+           \param inset ownership is _not_ passed to the frontend dialog.
+           It is stored internally and used by the kernel to ascertain
+           what to do with the FuncRequest dispatched from the frontend
+           dialog on 'Apply'; should it be used to create a new inset at
+           the current cursor position or modify an existing, 'open' inset?
+       */
        virtual void showDialog(std::string const & name,
                std::string const & data, Inset * inset = 0) = 0;