Platforms to show: All Mac Windows Linux Cross-Platform

ScintillaIndicatorMBS class

Type Topic Plugin Version macOS Windows Linux iOS Targets
class Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
Function: The class for an indicator.
Notes: This is an abstract class. You can't create an instance, but you can get one from various plugin functions.

Feedback, Comments & Corrections

Indicator Numbers

Constant Value Description
kIndicatorNumbersContainer 8
kIndicatorNumbersIme 32
kIndicatorNumbersImeMax 35
kIndicatorNumbersMax 35

Indicator Styles

Constant Value Description
kIndicatorStyleBox 6 A rectangle around the text.
kIndicatorStyleCompositionThick 14 A 2-pixel thick underline located at the bottom of the line to try to avoid touching the character base. Each side is inset 1 pixel so that different indicators in this style covering a range appear isolated. This is similar to an appearance used for the target in Asian language input composition.
kIndicatorStyleCompositionThin 15 A 1-pixel thick underline located just before the bottom of the line. Each side is inset 1 pixel so that different indicators in this style covering a range appear isolated. This is similar to an appearance used for non-target ranges in Asian language input composition.
kIndicatorStyleDash 9 A dashed underline.
kIndicatorStyleDiagonal 3 Diagonal hatching.
kIndicatorStyleDotBox 12 A dotted rectangle around the text using translucent drawing. Translucency alternates between the alpha and outline alpha settings with the top-left pixel using the alpha setting. Alpha and OutlineAlpha control the alpha transparency values. The default values are 30 for alpha and 50 for outline alpha. To avoid excessive memory allocation the maximum width of a dotted box is 4000 pixels.
kIndicatorStyleDots 10 A dotted underline.
kIndicatorStyleFullBox 16 A rectangle around the text using translucent drawing similar to kIndicatorStyleStraightBox but covering the entire character area.
kIndicatorStyleGradient 20 A vertical gradient between a colour and alpha at top to fully transparent at bottom.
kIndicatorStyleGradientCentre 21 A vertical gradient with the specified colour and alpha in the middle fading to fully transparent at top and bottom.
kIndicatorStyleHidden 5 An indicator with no visual effect.
kIndicatorStylePlain 0 Underlined with a single, straight line.
kIndicatorStylePoint 18 Draw a triangle below the start of the indicator range.
kIndicatorStylePointCharacter 19 Draw a triangle below the centre of the first character of the indicator range.
kIndicatorStyleRoundBox 7 A rectangle with rounded corners around the text using translucent drawing with the interior usually more transparent than the border. You can use Alpha and OutlineAlpha property to control the alpha transparency values. The default alpha values are 30 for fill colour and 50 for outline colour.
kIndicatorStyleSquiggle 1 A squiggly underline. Requires 3 pixels of descender space.
kIndicatorStyleSquiggleLow 11 Similar to kIndicatorStyleSquiggle but only using 2 vertical pixels so will fit under small fonts.
kIndicatorStyleSquigglePixmap 13 A version of kIndicatorStyleSquiggle that draws using a pixmap instead of as a series of line segments for performance.
kIndicatorStyleStraightBox 8 A rectangle around the text using translucent drawing with the interior usually more transparent than the border. You can use Alpha and OutlineAlpha to control the alpha transparency values. The default alpha values are 30 for fill colour and 50 for outline colour. This indicator does not colour the top pixel of the line so that indicators on contiguous lines are visually distinct and disconnected.
kIndicatorStyleStrike 4 Strike out.
kIndicatorStyleTextFore 17 Change the colour of the text to the indicator's fore colour.
kIndicatorStyleTT 2 A line of small T shapes.

Flags

Constant Value Description
kIndicFlagNone 0 Default value for flags.
kIndicFlagValueFore 1 When this flag is set the colour used by the indicator is not from the indicator's fore setting but instead from the value of the indicator at that point in the file.

This class has no sub classes.

Some methods using this class:

Some properties using for this class:

Some examples using this class:

Blog Entries


The items on this page are in the following plugins: MBS Scintilla Plugin.


ScintillaFailureExceptionMBS   -   ScintillaLoaderMBS

The biggest plugin in space...




Links
MBS Xojo Plugins

Start Chat