]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetinclude.h
Implemented controller-view split for FormError and FormInclude.
[lyx.git] / src / insets / insetinclude.h
index ff6477c0692b20527c5c3a11f5220483cdd4ad09..e57afeb0c7e23bd0de8edbaaa4af5591701504eb 100644 (file)
@@ -3,9 +3,9 @@
  * ======================================================
  *
  *           LyX, The Document Processor
- *      
+ *     
  *         Copyright 1997 LyX Team (this file was created this year)
- * 
+ *
  * ====================================================== */
 
 #ifndef INSET_INCLUDE_H
@@ -24,20 +24,58 @@ struct LaTeXFeatures;
 
 /**  Used to include files
  */
-class InsetInclude: public InsetCommand {
+class InsetInclude: public InsetButton, public 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(InsetCommandParams const &, Buffer *);
+       InsetInclude(Params const &);
+       ///
+       InsetInclude(InsetCommandParams const &, Buffer const &);
        ///
        ~InsetInclude();
-        ///
-        Inset * Clone() const;
+
+       /// get the parameters
+       Params const & params(void) const;
+       /// set the parameters
+       void set(Params const & params);
+
+       ///
+        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);
        ///
@@ -49,9 +87,11 @@ public:
         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;
@@ -62,117 +102,44 @@ public:
            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 
+       SigC::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
+       Params params_;
        ///
-       mutable string include_label;
+       string include_label;
 };
 
 
-inline 
-bool InsetInclude::isVerb() const
+inline bool InsetInclude::isVerbatim() const
 {
-       return flag == InsetInclude::VERB || flag == InsetInclude::VERBAST; 
+       return params_.flag == VERB || params_.flag == VERBAST;
 }
 
 
-inline
-void InsetInclude::setInput()
+inline bool InsetInclude::isIncludeOnly() const
 {
-       if (!isInput()) {
-           flag = InsetInclude::INPUT;
-           setCmdName("input");
-       }
+       return params_.flag == INCLUDE && params_.noload;
 }
 
-
-inline
-void InsetInclude::setNoLoad(bool b)
-{ 
-               noload = b;
-}
-
-
-inline
-void InsetInclude::setInclude()
-{
-       if (!isInclude()) {
-           flag = InsetInclude::INCLUDE;
-           setCmdName("include");
-       }
-}
-
-
-inline
-void InsetInclude::setVerb()
-{ 
-       if (!isVerb()) {
-           flag = InsetInclude::VERB;
-           setCmdName("verbatiminput");
-       }
-}
-
-
-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