Fix left/right border UI when toggling formal

[lyx.git] / src / insets / InsetCommandParams.h

diff --git a/src/insets/InsetCommandParams.h b/src/insets/InsetCommandParams.h
index 2ff6d5c27f9b0f5ae12f4f45cbe5407650432d40..eb976c28d7ce612ae5372bf2120d8400c0108ccf 100644 (file)
--- a/src/insets/InsetCommandParams.h
+++ b/src/insets/InsetCommandParams.h
@@ -16,6 +16,8 @@
 
 #include "InsetCode.h"
 
+#include "OutputParams.h"
+
 #include "support/docstring.h"
 
 #include <string>
@@ -26,31 +28,50 @@
 namespace lyx {
 
 class Lexer;
+class Buffer;
 
 class ParamInfo {
 public:
+       ///
+       ParamInfo() {}
        /// Types of parameters
        enum ParamType {
                LATEX_OPTIONAL,    /// normal optional argument
                LATEX_REQUIRED,    /// normal required argument
                LYX_INTERNAL       /// a parameter used internally by LyX
        };
+       /// Special handling on output
+       enum ParamHandling {
+               HANDLING_NONE = 1,    /// no special handling
+               HANDLING_ESCAPE = 2,  /// escape special characters
+               HANDLING_LATEXIFY = 4, /// transform special characters to LaTeX macros
+               HANDLING_LTRIM = 8, /// trim blanks on the left
+               HANDLING_INDEX_ESCAPE = 16, /// escape makeindex special chars
+       };
        ///
        class ParamData {
        // No parameter may be named "preview", because that is a required
        // flag for all commands.
        public:
                ///
-               ParamData(std::string const &, ParamType);
+               ParamData(std::string const &, ParamType, ParamHandling = HANDLING_NONE,
+                         bool ignore = false,
+                         docstring default_value = docstring());
                ///
                std::string name() const { return name_; }
                ///
                ParamType type() const { return type_; }
+               ///
+               ParamHandling handling() const { return handling_; }
                /// 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:
@@ -58,10 +79,20 @@ public:
                std::string name_;
                ///
                ParamType type_;
+               /// do we need special handling on latex output?
+               ParamHandling handling_;
+               ///
+               bool ignore_;
+               ///
+               docstring default_value_;
        };
 
        /// adds a new parameter
-       void add(std::string const & name, ParamType type);
+       /// 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, bool ignore = false,
+                docstring default_value = docstring());
        ///
        bool empty() const { return info_.empty(); }
        ///
@@ -73,7 +104,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;
@@ -97,20 +128,23 @@ public:
        std::string insetType() const;
        ///
        InsetCode code() const { return insetCode_; }
-       ///
-       void read(Lexer &);
        /// Parse the command
+       void read(Lexer &);
+       ///
+       void Read(Lexer &, Buffer const *);
        ///
        void write(std::ostream &) const;
+       ///
+       void Write(std::ostream & os, Buffer const * buf) const;
        /// Build the complete LaTeX command
-       docstring getCommand() const;
+       docstring getCommand(OutputParams const &) const;
        /// Return the command name
        std::string const & getCmdName() const { return cmdName_; }
        /// Set the name to \p n. This must be a known name. All parameters
        /// 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
@@ -127,7 +161,11 @@ public:
        void clear();
        ///
        static bool isCompatibleCommand(InsetCode code, std::string const & s);
-
+       ///
+       ParamInfo const & info() const { return info_; }
+       ///
+       docstring prepareCommand(OutputParams const & runparams,
+               docstring const & command, ParamInfo::ParamHandling handling) const;
 private:
        std::string getDefaultCmd(InsetCode code);
        /// checks whether we need to write an empty optional parameter