#ifndef DELEGATES_H
#define DELEGATES_H
-#include "support/docstring.h"
+#include "support/strfwd.h"
namespace lyx {
class Buffer;
+class DocIterator;
class Inset;
namespace frontend {
/// This function is called when some message shows up.
virtual void message(docstring const & msg) = 0;
- /// This function is called when some dialog needs to be shown.
- virtual void showDialog(std::string const & name) = 0;
-
- /// This function is called when some dialog needs to be shown with
- /// some data.
- virtual void showDialogWithData(std::string const & name,
- std::string const & data) = 0;
-
/// This function is called when some inset dialogs needs to be shown.
- virtual void showInsetDialog(std::string const & name,
- std::string const & data, Inset * inset) = 0;
+ /** \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;
- /// This function is called when some dialogs needs to be updated.
+ /// This function is called when some dialogs needs to be reset.
+ /** \param name == "citation", "bibtex" etc; an identifier used
+ to reset the contents of a particular dialog with \param data.
+ See the comments to 'show', above.
+ */
virtual void updateDialog(std::string const & name,
std::string const & data) = 0;
};
{
public:
virtual ~GuiBufferDelegate() {}
- /// This function is called when the buffer is changed.
- virtual void changed() = 0;
/// This function is called when the buffer structure is changed.
virtual void structureChanged() = 0;
- /// This function is called when an embedded file is changed
- virtual void embeddingChanged() = 0;
+ /// This function is called when the buffer structure has been updated.
+ virtual void updateTocItem(std::string const &, DocIterator const &) = 0;
/// This function is called when some parsing error shows up.
- virtual void errors(std::string const &) = 0;
+ virtual void errors(std::string const &, bool from_master = false) = 0;
/// This function is called when some message shows up.
virtual void message(docstring const &) = 0;
/// This function is called when the buffer busy status change.
- virtual void busy(bool) = 0;
- /// This function is called when the buffer readonly status change.
- virtual void readonly(bool) = 0;
- /// Update window titles of all users.
- virtual void updateTitles() = 0;
+ virtual void setBusy(bool) = 0;
/// Reset autosave timers for all users.
virtual void resetAutosaveTimers() = 0;
- /// This signal is emitting if the buffer is being closed.
- virtual void closing(Buffer *) = 0;
};
} // namespace frontend