]> git.lyx.org Git - features.git/blobdiff - src/insets/InsetInfo.h
XHTML/DocBook: merge code duplicates for vertical alignment.
[features.git] / src / insets / InsetInfo.h
index e7bb91d4bc50cec48f130e20062367c5a46ee1c3..3531b41681204964af5ea1be556b3e55fc176be1 100644 (file)
@@ -50,6 +50,20 @@ fixdate: Same as date. A fixed date (in ISO format) is prepended to the argument
     delimited by '@'.
     The output is a localized formatted fix date.
 
+time: argument of this type of InsetInfo is either a fixed time type of
+    "long" (long localized time, as provided by QLocale),
+    "short" (short localized time, as provided by QLocale),
+    "ISO" (ISO-conforming time)
+    or a custom date using the QTime syntax.
+    The output is a localized formatted (current) time.
+
+modtime: Same as time.
+    The output is a localized formatted time of last file modification (saving).
+
+fixtime: Same as time. A fixed time (in ISO format) is prepended to the argument,
+    delimited by '@'.
+    The output is a localized formatted fix time.
+
 shortcuts: argument is the name of the LFUN such as "math-insert \alpha".
     The syntax is the same as what is used in the bind and ui files.
     The output of this inset is all shortcuts for this LFUN separated by comma.
@@ -71,16 +85,21 @@ menu: argument is the name of the LFUN such as "paste". The syntax is the same
     triggers this LFUN. For example, "File > Paste", where '>' is actually
     \lyxarrow (an InsetSpecialChar).
 
+l7n: argument is an English string that is marked for localization. The output
+    is the localization of that string in the current GUI language (if available).
+    Trailing colons are stripped, accelerators removed.
+    This is used to refer to GUI items in the docs.
+
 icon: argument is the name of the LFUN such as "paste". The syntax is the same
     as what is used in the bind and ui files. The output is the icon use in
     the toolbar for this LFUN. Alternatively, argument can be the icon path
     without extension specified with respect to the images directory.
 
-buffer: argument can be one of "name", "path", "class". This inset output the
-    filename, path, and textclass of this buffer.
+buffer: argument can be one of "name", "name-noext", "path", "class". This inset output the
+    filename (with extension), filename (without extension), path, and textclass of this buffer.
 
-lyxinfo: argument must (presently) be "version". This inset outputs information
-    about the version of LyX currently in use.
+lyxinfo: argument must be "version" or "layoutformat". This outputs information
+    about the version of LyX currently in use or the current LyX layout format, respectively.
 
 vcs: argument can be one of "revision", "tree-revision", "author", "time", "date".
     This insets outputs revision control information, if available.
@@ -97,12 +116,15 @@ the command buffer (view->Toolbar->Command Buffer).
 
 */
 
-class InsetInfo : public InsetCollapsible {
+class InsetInfoParams {
 public:
        enum info_type {
-               DATE_INFO,       // Current Date
+               DATE_INFO,       // Current date
                MODDATE_INFO,    // Date of last modification
                FIXDATE_INFO,    // Fix date
+               TIME_INFO,       // Current time
+               MODTIME_INFO,    // Time of last modification
+               FIXTIME_INFO,    // Fix time
                BUFFER_INFO,     // Buffer related information
                VCS_INFO,        // Version control information
                PACKAGE_INFO,    // Availability of package
@@ -113,82 +135,111 @@ public:
                MENU_INFO,       // Which menu item is used for certain function
                ICON_INFO,       // which toolbar icon is used for certain function
                LYX_INFO,        // LyX version information
+               L7N_INFO,        // Localized string
                UNKNOWN_INFO,    // Invalid type
        };
+       ///
+       docstring getDate(std::string const &, QDate const date = QDate::currentDate()) const;
+       ///
+       docstring getTime(std::string const &, QTime const time = QTime::currentTime()) const;
+       ///
+       std::vector<std::pair<std::string,docstring>> getArguments(Buffer const * buf,
+                                                                  std::string const &) const;
+       ///
+       bool validateArgument(Buffer const * buf, docstring const & argument,
+                             bool const usedefault = false) const;
+       ///
+       info_type type;
+       ///
+       std::string infoType() const;
+       ///
+       std::string name;
+       ///
+       Language const * lang;
+       ///
+       bool force_ltr;
+};
+
+///
+extern InsetInfoParams infoparams;
 
+class InsetInfo : public InsetCollapsible {
+public:
        ///
        InsetInfo(Buffer * buf, std::string const & info = std::string());
        ///
-       InsetCode lyxCode() const { return INFO_CODE; }
+       InsetCode lyxCode() const override { return INFO_CODE; }
        ///
-       docstring layoutName() const;
+       docstring layoutName() const override;
        ///
-       Inset * editXY(Cursor & cur, int x, int y);
+       Inset * editXY(Cursor & cur, int x, int y) override;
        /** FIXME: we would like to do that, but then InsetText::updateBuffer breaks
         * on info insets. Do we need to run this method on InsetInfo contents?
         * Having a InsetInfo that hides an InsetText is really annoying, actually.
         */
-       ///bool isActive() const { return false; }
+       ///bool isActive() const override { return false; }
        ///
-       bool editable() const { return false; }
+       bool editable() const override { return false; }
        ///
-       bool hasSettings() const { return true; }
+       bool hasSettings() const override { return true; }
        ///
-       void read(Lexer & lex);
+       void read(Lexer & lex) override;
        ///
-       void write(std::ostream & os) const;
+       void write(std::ostream & os) const override;
        ///
-       std::string infoType() const;
+       bool validateModifyArgument(docstring const & argument) const override {
+               return params_.validateArgument(&buffer(), argument); }
        ///
-       std::string infoName() const { return name_; }
+       bool showInsetDialog(BufferView * bv) const override;
        ///
-       bool validateModifyArgument(docstring const & argument) const;
+       bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
        ///
-       std::vector<std::pair<std::string,docstring>> getArguments(std::string const &) const;
+       void doDispatch(Cursor & cur, FuncRequest & cmd) override;
+       /// Force inset into LTR environment if surroundings are RTL
+       bool forceLTR(OutputParams const &) const override;
        ///
-       bool showInsetDialog(BufferView * bv) const;
+       bool forceLocalFontSwitch() const override;
        ///
-       bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
+       void setInfo(std::string const & info);
        ///
-       void doDispatch(Cursor & cur, FuncRequest & cmd);
-       /// Force inset into LTR environment if surroundings are RTL
-       bool forceLTR() const;
+       void updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted = false) override;
        ///
-       void setInfo(std::string const & info);
+       void metrics(MetricsInfo & mi, Dimension & dim) const override;
+       ///
+       void draw(PainterInfo & pi, int x, int y) const override;
+
+       ///
+       docstring toolTip(BufferView const & bv, int x, int y) const override;
        ///
-       void updateBuffer(ParIterator const & it, UpdateType utype);
+       std::string contextMenu(BufferView const &, int, int) const override;
        ///
-       docstring toolTip(BufferView const & bv, int x, int y) const;
+       std::string contextMenuName() const override;
+       /// should paragraph indentation be omitted in any case?
+       bool neverIndent() const override { return true; }
        ///
-       std::string contextMenu(BufferView const &, int, int) const;
+       void validate(LaTeXFeatures & features) const override;
        ///
-       std::string contextMenuName() const;
-       /// should paragraph indendation be omitted in any case?
-       bool neverIndent() const { return true; }
+       InsetInfoParams params() const { return params_; }
 
 private:
        ///
-       virtual Inset * clone() const { return new InsetInfo(*this); }
+       Inset * clone() const override { return new InsetInfo(*this); }
        ///
        void error(docstring const & err, Language const *);
        ///
        void info(docstring const & err, Language const *);
        ///
        void setText(docstring const & str, Language const *);
-       ///
-       docstring getDate(std::string const, QDate const date = QDate::currentDate()) const;
        // make sure that the other version of setText is still available.
        using InsetCollapsible::setText;
+       /// Compute the information
+       void build();
        ///
        bool initialized_;
        ///
-       info_type type_;
-       ///
-       std::string name_;
-       ///
-       bool force_ltr_;
+       InsetInfoParams params_;
        ///
-       Language const * lang_;
+       friend class InsetInfoParams;
 };