mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-11 13:46:43 +00:00
2470d9297d
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@2681 a592a061-630c-0410-9148-cb99ea01b6c8
149 lines
3.4 KiB
C++
149 lines
3.4 KiB
C++
// -*- C++ -*-
|
|
/* This file is part of*
|
|
* ======================================================
|
|
*
|
|
* LyX, The Document Processor
|
|
*
|
|
* Copyright 1997 LyX Team (this file was created this year)
|
|
*
|
|
* ====================================================== */
|
|
|
|
#ifndef INSET_INCLUDE_H
|
|
#define INSET_INCLUDE_H
|
|
|
|
#ifdef __GNUG__
|
|
#pragma interface
|
|
#endif
|
|
|
|
#include "insetcommand.h"
|
|
|
|
class Buffer;
|
|
struct LaTeXFeatures;
|
|
|
|
// Created by AAS 970521
|
|
|
|
/** Used to include files
|
|
*/
|
|
class InsetInclude: public InsetButton, boost::noncopyable {
|
|
public:
|
|
/// the type of inclusion
|
|
enum Flags {
|
|
///
|
|
INCLUDE = 0,
|
|
///
|
|
VERB = 1,
|
|
///
|
|
INPUT = 2,
|
|
///
|
|
VERBAST = 3
|
|
};
|
|
|
|
struct Params {
|
|
Params(InsetCommandParams const & cp = InsetCommandParams(),
|
|
Flags f = INCLUDE,
|
|
bool nl = false,
|
|
string const & name = string())
|
|
: cparams(cp), flag(f), noload(nl),
|
|
masterFilename_(name) {}
|
|
InsetCommandParams cparams;
|
|
Flags flag;
|
|
bool noload;
|
|
string masterFilename_;
|
|
|
|
///
|
|
bool operator==(Params const &) const;
|
|
///
|
|
bool operator!=(Params const &) const;
|
|
};
|
|
|
|
///
|
|
InsetInclude(Params const &);
|
|
///
|
|
InsetInclude(InsetCommandParams const &, Buffer const &);
|
|
///
|
|
~InsetInclude();
|
|
|
|
/// get the parameters
|
|
Params const & params(void) const;
|
|
/// set the parameters
|
|
void set(Params const & params);
|
|
|
|
///
|
|
virtual Inset * clone(Buffer const &, bool same_id = false) const;
|
|
///
|
|
Inset::Code lyxCode() const { return Inset::INCLUDE_CODE; }
|
|
/// This returns the list of labels on the child buffer
|
|
std::vector<string> const getLabelList() const;
|
|
/// This returns the list of bibkeys on the child buffer
|
|
std::vector< std::pair<string,string> > const getKeys() const;
|
|
///
|
|
void edit(BufferView *, int x, int y, unsigned int button);
|
|
///
|
|
void edit(BufferView * bv, bool front = true);
|
|
///
|
|
EDITABLE editable() const
|
|
{
|
|
return IS_EDITABLE;
|
|
}
|
|
/// With lyx3 we won't overload these 3 methods
|
|
void write(Buffer const *, std::ostream &) const;
|
|
///
|
|
void read(Buffer const *, LyXLex &);
|
|
///
|
|
int latex(Buffer const *, std::ostream &,
|
|
bool fragile, bool free_spc) const;
|
|
///
|
|
int ascii(Buffer const *, std::ostream &, int linelen) const;
|
|
///
|
|
int linuxdoc(Buffer const *, std::ostream &) const;
|
|
///
|
|
int docbook(Buffer const *, std::ostream &) const;
|
|
///
|
|
void validate(LaTeXFeatures &) const;
|
|
|
|
/** Input inserts anything inside a paragraph.
|
|
Display can give some visual feedback
|
|
*/
|
|
bool display() const;
|
|
|
|
/// return the filename stub of the included file
|
|
string const getRelFileBaseName() const;
|
|
|
|
/// return true if the included file is not loaded
|
|
bool isIncludeOnly() const;
|
|
|
|
/// return true if the file is or got loaded.
|
|
bool loadIfNeeded() const;
|
|
|
|
/// hide a dialog if about
|
|
SigC::Signal0<void> hideDialog;
|
|
private:
|
|
/// get the text displayed on the button
|
|
string const getScreenLabel(Buffer const *) const;
|
|
/// is this a verbatim include ?
|
|
bool isVerbatim() const;
|
|
/// get the filename of the master buffer
|
|
string const getMasterFilename() const;
|
|
/// get the included file name
|
|
string const getFileName() const;
|
|
|
|
/// the parameters
|
|
Params params_;
|
|
///
|
|
string include_label;
|
|
};
|
|
|
|
|
|
inline bool InsetInclude::isVerbatim() const
|
|
{
|
|
return params_.flag == VERB || params_.flag == VERBAST;
|
|
}
|
|
|
|
|
|
inline bool InsetInclude::isIncludeOnly() const
|
|
{
|
|
return params_.flag == INCLUDE && params_.noload;
|
|
}
|
|
|
|
#endif
|