]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetBox.h
Internal buffers are valid
[lyx.git] / src / insets / InsetBox.h
index 4aa9336c6804d3c1222ba0af677ce504130d354c..d5610b746a0344a18d1cf551d5c72e91a3988e8f 100644 (file)
@@ -6,6 +6,7 @@
  *
  * \author Angus Leeming
  * \author Martin Vermeer
+ * \author Uwe Stöhr
  *
  * Full author contact details are available in file CREDITS.
  */
 #ifndef INSETBOX_H
 #define INSETBOX_H
 
-#include "InsetCollapsable.h"
+#include "InsetCollapsible.h"
 #include "Length.h"
-#include "MailInset.h"
 
 
 namespace lyx {
 
-class InsetBoxParams {
+class InsetBoxParams
+{
 public:
        ///
        InsetBoxParams(std::string const &);
@@ -28,16 +29,19 @@ public:
        void write(std::ostream & os) const;
        ///
        void read(Lexer & lex);
+
        ///
        std::string type;
-       /// Use a parbox (true) or minipage (false)
+       /// Is there a parbox?
        bool use_parbox;
+       /// Is there a makebox?
+       bool use_makebox;
        /// Do we have an inner parbox or minipage to format paragraphs to
        /// columnwidth?
        bool inner_box;
        ///
        Length width;
-       /// "special" widths, see usrguide.dvi §3.5
+       /// "special" widths, see usrguide.dvi Â§3.5
        std::string special;
        ///
        char pos;
@@ -49,109 +53,122 @@ public:
        Length height;
        ///
        std::string height_special;
+       ///
+       Length thickness;
+       ///
+       Length separation;
+       ///
+       Length shadowsize;
+       ///
+       std::string framecolor;
+       ///
+       std::string backgroundcolor;
 };
 
 
-/** The fbox/fancybox inset
 
-*/
-class InsetBox : public InsetCollapsable {
+///////////////////////////////////////////////////////////////////////
+//
+// The fbox/fancybox inset
+//
+///////////////////////////////////////////////////////////////////////
+
+
+class InsetBox : public InsetCollapsible
+{
 public:
        ///
-       InsetBox(Buffer const &, std::string const &);
+       enum BoxType {
+               Frameless,
+               Boxed,
+               Framed,
+               ovalbox,
+               Ovalbox,
+               Shadowbox,
+               Shaded,
+               Doublebox
+       };
        ///
-       ~InsetBox();
+       InsetBox(Buffer *, std::string const &);
+
+       ///
+       static std::string params2string(InsetBoxParams const &);
        ///
-       docstring editMessage() const;
+       static void string2params(std::string const &, InsetBoxParams &);
+       ///
+       InsetBoxParams const & params() const { return params_; }
+
+       /// \name Public functions inherited from Inset class
+       //@{
        ///
        InsetCode lyxCode() const { return BOX_CODE; }
        ///
-       docstring name() const;
+       docstring layoutName() const;
        ///
        void write(std::ostream &) const;
        ///
        void read(Lexer & lex);
        ///
-       void setButtonLabel();
-       ///
        void metrics(MetricsInfo &, Dimension &) const;
-       /// show the Box dialog
-       bool showInsetDialog(BufferView * bv) const;
        ///
        DisplayType display() const { return Inline; }
-       //FIXME Is this the one we want? or is it:
-       //allowParagraphCustomization(idx_type)?
        ///
-       virtual bool forceEmptyLayout() const;
+       ColorCode backgroundColor(PainterInfo const &) const;
        ///
-       bool neverIndent() const { return true; }
+       LyXAlignment contentAlignment() const;
        ///
-       bool noFontChange() const { return true; }
+       bool allowParagraphCustomization(idx_type = 0) const { return !forcePlainLayout(); }
        ///
-       bool isMacroScope() const;
+       bool allowMultiPar() const;
        ///
-       int latex(odocstream &, OutputParams const &) const;
+       bool forcePlainLayout(idx_type = 0) const;
        ///
-       int plaintext(odocstream &, OutputParams const &) const;
+       bool neverIndent() const { return true; }
        ///
-       int docbook(odocstream &, OutputParams const &) const;
+       bool inheritFont() const { return false; }
        ///
-       void validate(LaTeXFeatures &) const;
+       void latex(otexstream &, OutputParams const &) const;
        ///
-       InsetBoxParams const & params() const { return params_; }
+       int plaintext(odocstringstream & ods, OutputParams const & op,
+                     size_t max_length = INT_MAX) const;
        ///
-       bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
+       int docbook(odocstream &, OutputParams const &) const;
        ///
-       enum BoxType {
-               Frameless,
-               Boxed,
-               Framed,
-               ovalbox,
-               Ovalbox,
-               Shadowbox,
-               Shaded,
-               Doublebox
-       };
-protected:
-       InsetBox(InsetBox const &);
-       virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
-       /// Is the width forced to some value?
-       virtual bool hasFixedWidth() const;
-private:
-       friend class InsetBoxParams;
-
-       virtual Inset * clone() const;
-
-       /// used by the constructors
-       void init();
+       docstring xhtml(XHTMLStream &, OutputParams const &) const;
        ///
-       InsetBoxParams params_;
-};
-
-
-class InsetBoxMailer : public MailInset {
-public:
+       void validate(LaTeXFeatures &) const;
        ///
-       InsetBoxMailer(InsetBox & inset);
+       bool hasFixedWidth() const;
        ///
-       virtual Inset & inset() const { return inset_; }
+       std::string contextMenuName() const;
+       //@}
+
+       /// \name Public functions inherited from InsetCollapsible class
+       //@{
        ///
-       virtual std::string const & name() const { return name_; }
+       void setButtonLabel();
+       //@}
+
+protected:
+       /// \name Protected functions inherited from Inset class
+       //@{
        ///
-       virtual std::string const inset2string(Buffer const &) const;
+       bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
        ///
-       static std::string const params2string(InsetBoxParams const &);
+       void doDispatch(Cursor & cur, FuncRequest & cmd);
        ///
-       static void string2params(std::string const &, InsetBoxParams &);
+       Inset * clone() const { return new InsetBox(*this); }
+       //@}
 
 private:
+       /// used by the constructors
+       void init();
+
        ///
-       static std::string const name_;
-       ///
-       InsetBox & inset_;
+       friend class InsetBoxParams;
+       InsetBoxParams params_;
 };
 
-
 } // namespace lyx
 
-#endif // INSET_BOX_H
+#endif // INSETBOX_H