This commit is contained in:
Juergen Spitzmueller 2021-03-04 14:52:39 +01:00
parent 5920591b52
commit 8718d01770

View File

@ -378,8 +378,8 @@ private:
bool lfunUiToggle(std::string const & ui_component); bool lfunUiToggle(std::string const & ui_component);
/// ///
void toggleFullScreen(); void toggleFullScreen();
/// \return whether we did anything /// \return whether we did anything
bool insertLyXFile(docstring const & fname, bool ignorelang = false); bool insertLyXFile(docstring const & fname, bool ignorelang = false);
/// ///
/// Open Export As ... dialog. \p iformat is the format the /// Open Export As ... dialog. \p iformat is the format the
/// filter is initially set to. /// filter is initially set to.
@ -396,23 +396,23 @@ private:
std::string const getTemplatesPath(Buffer & buf); std::string const getTemplatesPath(Buffer & buf);
/// Save a buffer as a new file. /// Save a buffer as a new file.
/** /**
Write a buffer to a new file name and rename the buffer * Write a buffer to a new file name and rename the buffer
according to the new file name. * according to the new file name.
*
This function is e.g. used by menu callbacks and * This function is e.g. used by menu callbacks and
LFUN_BUFFER_WRITE_AS. * LFUN_BUFFER_WRITE_AS.
*
If 'newname' is empty, the user is asked via a * If 'newname' is empty, the user is asked via a
dialog for the buffer's new name and location. * dialog for the buffer's new name and location.
*
If 'newname' is non-empty and has an absolute path, that is used. * If 'newname' is non-empty and has an absolute path, that is used.
Otherwise the base directory of the buffer is used as the base * Otherwise the base directory of the buffer is used as the base
for any relative path in 'newname'. * for any relative path in 'newname'.
*
\p kind controls what is done besides the pure renaming: * \p kind controls what is done besides the pure renaming:
* LV_WRITE_AS => The buffer is written without version control actions. * LV_WRITE_AS => The buffer is written without version control actions.
* LV_VC_RENAME => The file is renamed in version control. * LV_VC_RENAME => The file is renamed in version control.
* LV_VC_COPY => The file is copied in version control. * LV_VC_COPY => The file is copied in version control.
*/ */
bool renameBuffer(Buffer & b, docstring const & newname, bool renameBuffer(Buffer & b, docstring const & newname,
RenameKind kind = LV_WRITE_AS); RenameKind kind = LV_WRITE_AS);
@ -427,7 +427,7 @@ private:
/// closes the tabworkarea and all tabs. If we are in a close event, /// closes the tabworkarea and all tabs. If we are in a close event,
/// all buffers will be closed, otherwise they will be hidden. /// all buffers will be closed, otherwise they will be hidden.
bool closeTabWorkArea(TabWorkArea * twa); bool closeTabWorkArea(TabWorkArea * twa);
/// gives the user the possibility to save their work /// gives the user the possibility to save their work
/// or to discard the changes. If hiding is true, the /// or to discard the changes. If hiding is true, the
/// document will be reloaded. /// document will be reloaded.
bool saveBufferIfNeeded(Buffer & buf, bool hiding); bool saveBufferIfNeeded(Buffer & buf, bool hiding);