QsciStyle Class Reference
The
QsciStyle class encapsulates all the attributes of a style.
More...
#include <qscistyle.h>
List of all members.
Public Types
- enum TextCase { OriginalCase = 0,
UpperCase = 1,
LowerCase = 2
}
Public Member Functions
Detailed Description
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.
Member Enumeration Documentation
This enum defines the different ways the displayed case of the text can be changed.
- Enumerator:
-
OriginalCase |
The text is displayed as its original case. |
UpperCase |
The text is displayed as upper case. |
LowerCase |
The text is displayed as lower case. |
Constructor & Destructor Documentation
QsciStyle::QsciStyle |
( |
int |
style = -1 |
) |
|
Constructs a QsciStyle instance for style number style. If style is negative then a new style number is automatically allocated.
QsciStyle::QsciStyle |
( |
int |
style, |
|
|
const QString & |
description, |
|
|
const QColor & |
color, |
|
|
const QColor & |
paper, |
|
|
const QFont & |
font, |
|
|
bool |
eol_fill = false | |
|
) |
| | |
Constructs a QsciStyle instance for style number style. If style is negative then a new style number is automatically allocated. The styles description, color, paper color, font and end-of-line fill are set to description, color, paper, font and eol_fill respectively.
Member Function Documentation
int QsciStyle::style |
( |
|
) |
const [inline] |
Returns the number of the style.
void QsciStyle::setDescription |
( |
const QString & |
description |
) |
[inline] |
The style's description is set to description.
- See also:
- description()
QString QsciStyle::description |
( |
|
) |
const [inline] |
void QsciStyle::setColor |
( |
const QColor & |
color |
) |
|
The style's foreground color is set to color. The default is taken from the application's default palette.
- See also:
- color()
QColor QsciStyle::color |
( |
|
) |
const [inline] |
Returns the style's foreground color.
- See also:
- setColor()
void QsciStyle::setPaper |
( |
const QColor & |
paper |
) |
|
The style's background color is set to paper. The default is taken from the application's default palette.
- See also:
- paper()
QColor QsciStyle::paper |
( |
|
) |
const [inline] |
Returns the style's background color.
- See also:
- setPaper()
void QsciStyle::setFont |
( |
const QFont & |
font |
) |
|
The style's font is set to font. The default is the application's default font.
- See also:
- font()
QFont QsciStyle::font |
( |
|
) |
const [inline] |
void QsciStyle::setEolFill |
( |
bool |
fill |
) |
|
The style's end-of-line fill is set to fill. The default is false.
- See also:
- eolFill()
bool QsciStyle::eolFill |
( |
|
) |
const [inline] |
void QsciStyle::setTextCase |
( |
TextCase |
text_case |
) |
|
The style's text case is set to text_case. The default is OriginalCase.
- See also:
- textCase()
TextCase QsciStyle::textCase |
( |
|
) |
const [inline] |
void QsciStyle::setVisible |
( |
bool |
visible |
) |
|
The style's visibility is set to visible. The default is true.
- See also:
- visible()
bool QsciStyle::visible |
( |
|
) |
const [inline] |
void QsciStyle::setChangeable |
( |
bool |
changeable |
) |
|
The style's changeability is set to changeable. The default is true.
- See also:
- changeable()
bool QsciStyle::changeable |
( |
|
) |
const [inline] |
void QsciStyle::setHotspot |
( |
bool |
hotspot |
) |
|
The style's sensitivity to mouse clicks is set to hotspot. The default is false.
- See also:
- hotspot()
bool QsciStyle::hotspot |
( |
|
) |
const [inline] |
Returns the style's sensitivity to mouse clicks.
- See also:
- setHotspot()
void QsciStyle::refresh |
( |
|
) |
|
Refresh the style settings.