* ======================================================
*
* LyX, The Document Processor
- *
+ *
* Copyright 1997 LyX Team (this file was created this year)
- *
+ *
* ====================================================== */
#ifndef INSET_INCLUDE_H
/** Used to include files
*/
-class InsetInclude: public InsetCommand {
+class InsetInclude: public InsetButton, public noncopyable {
public:
+ /// the type of inclusion
+ enum IncludeFlags {
+ ///
+ INCLUDE= 0,
+ ///
+ VERB = 1,
+ ///
+ INPUT = 2,
+ ///
+ VERBAST = 3
+ };
+
+ struct InsetIncludeParams {
+ InsetIncludeParams(InsetCommandParams const & cp = InsetCommandParams(),
+ IncludeFlags f = INCLUDE, bool nl = false, Buffer const * b = 0)
+ : cparams(cp), flag(f), noload(nl), buffer(b) {}
+ InsetCommandParams cparams;
+ IncludeFlags flag;
+ bool noload;
+ Buffer const * buffer;
+ };
+
+ ///
+ InsetInclude(InsetIncludeParams const &);
///
- InsetInclude(InsetCommandParams const &, Buffer *);
+ InsetInclude(InsetCommandParams const &, Buffer const &);
///
~InsetInclude();
+
+ /// get the parameters
+ InsetIncludeParams const & params(void) const;
+
+ /// set the parameters
+ void setFromParams(InsetIncludeParams const & params);
+
///
- Inset * Clone() const;
+ Inset * Clone(Buffer const &) const;
///
Inset::Code LyxCode() const { return Inset::INCLUDE_CODE; }
/// This returns the list of labels on the child buffer
- std::vector<string> getLabelList() const;
+ std::vector<string> const getLabelList() const;
/// This returns the list of bibkeys on the child buffer
- std::vector< std::pair<string,string> > getKeys() const;
+ std::vector< std::pair<string,string> > const getKeys() const;
///
void Edit(BufferView *, int x, int y, unsigned int button);
///
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;
Display can give some visual feedback
*/
bool display() const;
- ///
- string getScreenLabel() const;
- ///
- string getMasterFilename() const;
- ///
- string getFileName() const;
- /// In "input" mode uses \input instead of \include.
- bool isInput() const { return flag == InsetInclude::INPUT; }
- /// If this is true, the child file shouldn't be loaded by lyx
- bool isNoLoad() const { return noload; }
+ /// return the filename stub of the included file
+ string const getRelFileBaseName() const;
+
+ /// return true if the included file is not loaded
+ bool isIncludeOnly() const;
- /** A verbatim file shouldn't be loaded by LyX
- * No need to generate LaTeX code of a verbatim file
- */
- bool isVerb() const;
- ///
- bool isVerbVisibleSpace() const {
- return flag == InsetInclude::VERBAST;
- }
- ///
- bool isInclude() const { return flag == InsetInclude::INCLUDE;}
- ///
- void setInput();
- ///
- void setNoLoad(bool);
- ///
- void setInclude();
- ///
- void setVerb();
- ///
- void setVisibleSpace(bool b);
/// return true if the file is or got loaded.
bool loadIfNeeded() const;
+
+ /// hide a dialog if about
+ Signal0<void> hideDialog;
private:
- ///
- enum Include_Flags {
- ///
- INCLUDE= 0,
- ///
- VERB = 1,
- ///
- INPUT = 2,
- ///
- VERBAST = 3
- };
-
- ///
- bool noload;
- ///
- int flag;
- ///
- Buffer * master;
+ /// get the text displayed on the button
+ string const getScreenLabel() 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
+ InsetIncludeParams params_;
///
- mutable string include_label;
+ string include_label;
};
-inline
-bool InsetInclude::isVerb() const
-{
- return flag == InsetInclude::VERB || flag == InsetInclude::VERBAST;
-}
-
-
-inline
-void InsetInclude::setInput()
+inline bool InsetInclude::isVerbatim() const
{
- if (!isInput()) {
- flag = InsetInclude::INPUT;
- setCmdName("input");
- }
+ return params_.flag == VERB || params_.flag == VERBAST;
}
-inline
-void InsetInclude::setNoLoad(bool b)
-{
- noload = b;
-}
-
-
-inline
-void InsetInclude::setInclude()
+inline bool InsetInclude::isIncludeOnly() const
{
- if (!isInclude()) {
- flag = InsetInclude::INCLUDE;
- setCmdName("include");
- }
-}
-
-
-inline
-void InsetInclude::setVerb()
-{
- if (!isVerb()) {
- flag = InsetInclude::VERB;
- setCmdName("verbatiminput");
- }
+ return params_.flag == INCLUDE && params_.noload;
}
-
-inline
-void InsetInclude::setVisibleSpace(bool b)
-{
- if (b && flag == InsetInclude::VERB) {
- setCmdName("verbatiminput*");
- flag = InsetInclude::VERBAST;
- } else if (!b && flag == InsetInclude::VERBAST) {
- setCmdName("verbatiminput");
- flag = InsetInclude::VERB;
- }
-}
#endif