Mercurial > octave
diff libgui/languages/build_ts/octave-qsci/Qsci/qscistyle.h @ 31537:5ceb4bfcdb0f stable
add tools and files for updating the gui's language files for translation
* libgui/languages/build_ts/README.md: readme for updating language files
* libgui/languages/build_ts/octave-qsci: QScintilla source files for
languages without translation provided by QScintilla
* libgui/languages/build_ts/octave-qt: Qt source files for languages
without translation provided by Qt
author | Torsten Lilge <ttl-octave@mailbox.org> |
---|---|
date | Thu, 24 Nov 2022 06:48:25 +0100 |
parents | |
children | dd5ece3664ed |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libgui/languages/build_ts/octave-qsci/Qsci/qscistyle.h Thu Nov 24 06:48:25 2022 +0100 @@ -0,0 +1,204 @@ +// This module defines interface to the QsciStyle class. +// +// Copyright (c) 2019 Riverbank Computing Limited <info@riverbankcomputing.com> +// +// This file is part of QScintilla. +// +// This file may be used under the terms of the GNU General Public License +// version 3.0 as published by the Free Software Foundation and appearing in +// the file LICENSE included in the packaging of this file. Please review the +// following information to ensure the GNU General Public License version 3.0 +// requirements will be met: http://www.gnu.org/copyleft/gpl.html. +// +// If you do not wish to use this file under the terms of the GPL version 3.0 +// then you may purchase a commercial license. For more information contact +// info@riverbankcomputing.com. +// +// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE +// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. + + +#ifndef QSCISTYLE_H +#define QSCISTYLE_H + +#include <qcolor.h> +#include <qfont.h> +#include <qstring.h> + +#include <Qsci/qsciglobal.h> + + +class QsciScintillaBase; + + +//! \brief The QsciStyle class encapsulates all the attributes of a style. +//! +//! Each character of a document has an associated style which determines how +//! the character is displayed, e.g. its font and color. A style is identified +//! by a number. Lexers define styles for each of the language's features so +//! that they are displayed differently. Some style numbers have hard-coded +//! meanings, e.g. the style used for call tips. +class QSCINTILLA_EXPORT QsciStyle +{ +public: + //! This enum defines the different ways the displayed case of the text can + //! be changed. + enum TextCase { + //! The text is displayed as its original case. + OriginalCase = 0, + + //! The text is displayed as upper case. + UpperCase = 1, + + //! The text is displayed as lower case. + LowerCase = 2 + }; + + //! Constructs a QsciStyle instance for style number \a style. If \a style + //! is negative then a new style number is automatically allocated if + //! possible. If it is not possible then style() will return a negative + //! value. + //! + //! \sa style() + QsciStyle(int style = -1); + + //! Constructs a QsciStyle instance for style number \a style. If \a style + //! is negative then a new style number is automatically allocated if + //! possible. If it is not possible then style() will return a negative + //! value. The styles description, color, paper color, font and + //! end-of-line fill are set to \a description, \a color, \a paper, \a font + //! and \a eolFill respectively. + //! + //! \sa style() + QsciStyle(int style, const QString &description, const QColor &color, + const QColor &paper, const QFont &font, bool eolFill = false); + + //! \internal Apply the style to a particular editor. + void apply(QsciScintillaBase *sci) const; + + //! The style's number is set to \a style. + //! + //! \sa style() + void setStyle(int style) {style_nr = style;} + + //! Returns the number of the style. This will be negative if the style is + //! invalid. + //! + //! \sa setStyle() + int style() const {return style_nr;} + + //! The style's description is set to \a description. + //! + //! \sa description() + void setDescription(const QString &description) {style_description = description;} + + //! Returns the style's description. + //! + //! \sa setDescription() + QString description() const {return style_description;} + + //! The style's foreground color is set to \a color. The default is taken + //! from the application's default palette. + //! + //! \sa color() + void setColor(const QColor &color); + + //! Returns the style's foreground color. + //! + //! \sa setColor() + QColor color() const {return style_color;} + + //! The style's background color is set to \a paper. The default is taken + //! from the application's default palette. + //! + //! \sa paper() + void setPaper(const QColor &paper); + + //! Returns the style's background color. + //! + //! \sa setPaper() + QColor paper() const {return style_paper;} + + //! The style's font is set to \a font. The default is the application's + //! default font. + //! + //! \sa font() + void setFont(const QFont &font); + + //! Returns the style's font. + //! + //! \sa setFont() + QFont font() const {return style_font;} + + //! The style's end-of-line fill is set to \a fill. The default is false. + //! + //! \sa eolFill() + void setEolFill(bool fill); + + //! Returns the style's end-of-line fill. + //! + //! \sa setEolFill() + bool eolFill() const {return style_eol_fill;} + + //! The style's text case is set to \a text_case. The default is + //! OriginalCase. + //! + //! \sa textCase() + void setTextCase(TextCase text_case); + + //! Returns the style's text case. + //! + //! \sa setTextCase() + TextCase textCase() const {return style_case;} + + //! The style's visibility is set to \a visible. The default is true. + //! + //! \sa visible() + void setVisible(bool visible); + + //! Returns the style's visibility. + //! + //! \sa setVisible() + bool visible() const {return style_visible;} + + //! The style's changeability is set to \a changeable. The default is + //! true. + //! + //! \sa changeable() + void setChangeable(bool changeable); + + //! Returns the style's changeability. + //! + //! \sa setChangeable() + bool changeable() const {return style_changeable;} + + //! The style's sensitivity to mouse clicks is set to \a hotspot. The + //! default is false. + //! + //! \sa hotspot() + void setHotspot(bool hotspot); + + //! Returns the style's sensitivity to mouse clicks. + //! + //! \sa setHotspot() + bool hotspot() const {return style_hotspot;} + + //! Refresh the style settings. + void refresh(); + +private: + int style_nr; + QString style_description; + QColor style_color; + QColor style_paper; + QFont style_font; + bool style_eol_fill; + TextCase style_case; + bool style_visible; + bool style_changeable; + bool style_hotspot; + + void init(int style); +}; + +#endif