lyx_mirror/src/buffer_funcs.h
2020-10-13 09:57:36 +03:00

50 lines
1.3 KiB
C++

// -*- C++ -*-
/* \file buffer_funcs.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bjønnes
* \author Alfredo Braunstein
*
* Full author contact details are available in file CREDITS.
*/
#ifndef BUFFER_FUNCS_H
#define BUFFER_FUNCS_H
#include <string>
namespace lyx {
namespace support { class FileName; }
class Buffer;
/**
* Checks and loads a LyX file \param filename.
* \retval the newly created \c Buffer pointer if successful or 0.
* \retval 0 if the \c Buffer could not be created.
*/
Buffer * checkAndLoadLyXFile(support::FileName const & filename,
bool acceptDirty = false);
/** Make a new file (buffer) with name \c filename based on a template
* named \c templatename
*/
Buffer * newFile(std::string const & filename, std::string const & templatename,
bool isNamed = false);
/** Make a new unnamed file (buffer) with prefix \c prefix
* based on a template named \c templatename
*/
Buffer * newUnnamedFile(support::FileName const & path,
std::string const & prefix, std::string const & templatename = "");
/// Load the file with name \c fname, and returns the buffer. If the
/// file was already loaded it just returns the associated buffer.
Buffer * loadIfNeeded(support::FileName const & fname);
} // namespace lyx
#endif // BUFFER_FUNCS_H