Classes > WaveformAnalyzer class > Data structures > WANALYZER_SCROLLBARS

The WANALYZER_SCROLLBARS_SETTINGS structure describes settings applied while rendering the scrollbars on the Waveform Analyzer. The current settings can be retrieved through the WaveformAnalyzer.SettingsScrollbarsGet method and modified through the WaveformAnalyzer.SettingsScrollbarsSet method.

For details about the use of the Waveform Analyzer refer to the How to use the Waveform Analyzer section.

For further details about methods of the Waveform Analyzer refer to the WaveformAnalyzer class section.

C# definition

public struct WANALYZER_SCROLLBARS_SETTINGS

{

public Int16 nHeightInPixels;

public enumWaveScrollbarType nType;

public enumGraphicItemMaskValues nGraphicItemsMask;

public bool bVisibleTop;

public bool bVisibleBottom;

public Color colorBackground;

public Color colorThumb;

public Color colorVisibleRange;

public enumScrollbarWaveVisibleRangeType nVisibleRangeType;

public Int16 nVisibleRangeTranspGlassFactor;

public Int16 nVisibleRangeLinesWidth;

public bool bEnabledDuringPlayback;

public enumTranspGlassType nTransparentGlassType;

public Int16 nTransparentGlassPos3D;

public bool bTransparentGlassInvert3D;

}

Member

Description

nHeightInPixels

Height of the scrollbars in pixels.

By default this value is set to 12.

If the nType field below is set to WSCROLLBAR_TYPE_RECT, this field cannot be set to a value lower than 6.

If the nType field below is set to WSCROLLBAR_TYPE_WAVEFORM, this field cannot be set to a value lower than 12.

Eventual lower values will be automatically capped to the nearest valid value.

nType

Determines how the scrollbar is visualized.

Supported values are the following:

Mnemonic constant	Value	Meaning
WSCROLLBAR_TYPE_RECT (default)	0	Scrollbars are rendered as a 3D rectangle
WSCROLLBAR_TYPE_WAVEFORM	1	Scrollbars display a small sized representation of the full waveform
WSCROLLBAR_TYPE_WAVEFORM_ABS	2	Scrollbars display a small sized representation of the full waveform with absolute values.

On the screenshots below you can see that two different types of scrollbar; in all cases you can resize the visible range by dragging the provided handles with the left mouse button:

nGraphicItemsMask

Combination of values determining the mask of graphic items that must be drawn on the waveform scrollbar.

By default this

Supported values are the following:

Mnemonic constant	Value	Meaning
MASK_GRAPHIC_ITEM_NONE (default)	0	No graphic item is drawn
MASK_GRAPHIC_ITEM_VERTICAL_LINE	1	Draws vertical lines
MASK_GRAPHIC_ITEM_HORIZONTAL_LINE	2	Draws horizontal lines
MASK_GRAPHIC_ITEM_WAVE_RANGE	4	Draw wave ranges

bVisibleTop

Boolean value that specifies if the top scrollbar is visible.

Supported values are the following:

Mnemonic constant	Meaning
False	Doesn't display top scrollbar
True (default)	Displays top scrollbar

bVisibleBottom

Boolean value that specifies if the bottom scrollbar is visible.Supported values are the following:

Mnemonic constant	Meaning
False	Doesn't display bottom scrollbar
True (default)	Displays bottom scrollbar

colorBackground

Color used for rendering the scrollbars background.

colorThumb

Color used for rendering the scrollbars thumb.

colorVisibleRange

Color used for rendering inside the scrollbars the waveform background for visible range.

This setting is ignored when the nType field above is set to a value different from WSCROLLBAR_TYPE_WAVEFORM.

nVisibleRangeType

Determines how the visible range of the waveform is displayed.

This setting is ignored when the nType field above is set to a value different from WSCROLLBAR_TYPE_WAVEFORM

Supported values are the following:

Mnemonic constant	Value	Meaning
SCROLL_WAVE_VISIBLE_LINES (default)	0	Displays two lines on top and bottom
SCROLL_WAVE_VISIBLE_LINE_TOP	1	Displays one line on top
SCROLL_WAVE_VISIBLE_LINE_BOTTOM	2	Displays one line on bottom
SCROLL_WAVE_VISIBLE_TRANSP_GLASS_INNER	3	Displays a transparent glass over the portion of waveform representing the visible range
SCROLL_WAVE_VISIBLE_TRANSP_GLASS_OUTER	4	Displays a transparent glass over portions of waveform representing ranges of the waveform outside of the visible area.

nVisibleRangeTranspGlassFactor

Transparent factor applied to the transparent glass.

This value can range from 0 (total opacity) to 255 (total transparency) with a default value of 128. Values outside of this range will be automatically capped to the nearest valid value.

This setting is ignored when the nType field above is set to a value different from WSCROLLBAR_TYPE_WAVEFORM.

This setting is ignored when the nVisibleRangeType field above is set to a value different from SCROLL_WAVE_VISIBLE_TRANSP_GLASS_INNER or SCROLL_WAVE_VISIBLE_TRANSP_GLASS_OUTER.

nVisibleRangeLinesWidth

Width of lines in pixels.

Cannot assume values lower than 1. The default value is 2.

This setting is ignored when the nType field above is set to a value different from WSCROLLBAR_TYPE_WAVEFORM.

This setting is ignored when the nVisibleRangeType field above is set to SCROLL_WAVE_VISIBLE_TRANSP_GLASS_INNER or SCROLL_WAVE_VISIBLE_TRANSP_GLASS_OUTER.

bEnabledDuringPlayback

Boolean value that specifies if scrollbars are enabled during playback.

Supported values are the following:

Mnemonic constant	Meaning
False (default)	Scrollbars are disabled during playback
True	Scrollbars are enabled during playback

nTransparentGlassType

Type of transparent glass.

Supported values are the following:

Mnemonic constant	Value	Meaning
TRANSP_GLASS_TYPE_FLAT	0	Flat glass.
TRANSP_GLASS_TYPE_3D_VERT (default)	1	3D vertical glass.
TRANSP_GLASS_TYPE_3D_HORZ	2	3D horizontal glass.

This setting is ignored when the nType field above is set to a value different from WSCROLLBAR_TYPE_WAVEFORM.

This setting is ignored when the nVisibleRangeType field above is set to a value different from SCROLL_WAVE_VISIBLE_TRANSP_GLASS_INNER or SCROLL_WAVE_VISIBLE_TRANSP_GLASS_OUTER.

nTransparentGlassPos3D

Position of the 3D effect for the transparent glass.

This value can range from 0 to 100 with a default value of 50. Values outside of this range will be automatically capped to the nearest valid value.

This setting is ignored when the nType field above is set to a value different from WSCROLLBAR_TYPE_WAVEFORM.

This setting is ignored when the nVisibleRangeType field above is set to a value different from SCROLL_WAVE_VISIBLE_TRANSP_GLASS_INNER or SCROLL_WAVE_VISIBLE_TRANSP_GLASS_OUTER.

nTransparentGlassInvert3D

Boolean value that specifies if the transparency of the 3D effect is inverted.

Supported values are the following:

Mnemonic constant	Meaning
False (default)	Doesn't invert 3D effect
True	Inverts 3D effect

This setting is ignored when the nType field above is set to a value different from WSCROLLBAR_TYPE_WAVEFORM.

This setting is ignored when the nVisibleRangeType field above is set to a value different from SCROLL_WAVE_VISIBLE_TRANSP_GLASS_INNER or SCROLL_WAVE_VISIBLE_TRANSP_GLASS_OUTER.