]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCommandParams.h
Fix trailing whitespace in cpp files.
[lyx.git] / src / insets / InsetCommandParams.h
index c983c335a1f37e6ca586d7f75f51dfd2f6524948..121fdac176c2af197643aa7b57fbf30f13b0892a 100644 (file)
@@ -52,7 +52,9 @@ public:
        // flag for all commands.
        public:
                ///
-               ParamData(std::string const &, ParamType, ParamHandling = HANDLING_NONE);
+               ParamData(std::string const &, ParamType, ParamHandling = HANDLING_NONE,
+                         bool ignore = false,
+                         docstring default_value = docstring());
                ///
                std::string name() const { return name_; }
                ///
@@ -62,8 +64,12 @@ public:
                /// whether this is an optional LaTeX argument
                bool isOptional() const;
                ///
+               bool ignore() const { return ignore_; }
+               ///
+               docstring const & defaultValue() const { return default_value_; }
+               ///
                bool operator==(ParamData const &) const;
-               /// 
+               ///
                bool operator!=(ParamData const & rhs) const
                        { return !(*this == rhs); }
        private:
@@ -73,11 +79,18 @@ public:
                ParamType type_;
                /// do we need special handling on latex output?
                ParamHandling handling_;
+               ///
+               bool ignore_;
+               ///
+               docstring default_value_;
        };
 
        /// adds a new parameter
+       /// If ignore is true, then the parameter is never saved, and is always
+       /// given the default value.
        void add(std::string const & name, ParamType type,
-                ParamHandling = HANDLING_NONE);
+                ParamHandling = HANDLING_NONE, bool ignore = false,
+                docstring default_value = docstring());
        ///
        bool empty() const { return info_.empty(); }
        ///
@@ -89,7 +102,7 @@ public:
        ///
        const_iterator const end() const { return info_.end(); }
        /// \return true if name corresponds to a parameter of some sort.
-       /// \return false if the parameter does not exist at all of it it 
+       /// \return false if the parameter does not exist at all of it it
        bool hasParam(std::string const & name) const;
        ///
        ParamData const & operator[](std::string const & name) const;
@@ -113,9 +126,10 @@ public:
        std::string insetType() const;
        ///
        InsetCode code() const { return insetCode_; }
-       ///
-       void read(Lexer &, Buffer const *);
        /// Parse the command
+       void read(Lexer &);
+       ///
+       void Read(Lexer &, Buffer const *);
        ///
        void write(std::ostream &) const;
        ///
@@ -128,7 +142,7 @@ public:
        /// are cleared except those that exist also in the new command.
        /// What matters here is the parameter name, not position.
        void setCmdName(std::string const & n);
-       /// FIXME Would be better removed, but is used in BufferView.cpp in 
+       /// FIXME Would be better removed, but is used in BufferView.cpp in
        /// ways that make removal hard.
        docstring getFirstNonOptParam() const;
        /// get parameter \p name
@@ -145,7 +159,7 @@ public:
        void clear();
        ///
        static bool isCompatibleCommand(InsetCode code, std::string const & s);
-       /// 
+       ///
        ParamInfo const & info() const { return info_; }
        ///
        docstring prepareCommand(OutputParams const & runparams,