StyleControl

class HPS.StyleControl : public HPS.Control

The StyleControl class is a smart pointer that is tied to a database object. Controls are used for manipulating settings within the database.

Public Functions

HPS.StyleKey AppendNamed (string in_style_name, HPS.ConditionalExpression in_conditional)

Appends a conditional expression to an existing style or conditional style. If the style does not currently exist, a new conditional style is pushed. Conditional styles are only applied if their condition(s) are satisfied.

Param in_style_name

The name of the named style which should be defined in an accessible portfolio.

Param in_conditional

A conditional expression that must be satisfied in order for the style to be applied.

Return

a StyleKey that can be used to interact with the style.

HPS.StyleKey AppendNamed (string in_style_name, HPS.ConditionalExpression in_conditional, HPS.Style.AppendMode in_mode)

Appends a conditional expression to an existing style or conditional style. If the style does not currently exist, a new conditional style is pushed. Conditional styles are only applied if their condition(s) are satisfied.

Param in_style_name

The name of the named style which should be defined in an accessible portfolio.

Param in_conditional

A conditional expression that must be satisfied in order for the style to be applied.

Param in_mode

The behavior of the conditional expression if another conditional style is currently applied with the same style.

Return

a StyleKey that can be used to interact with the style.

HPS.StyleKey AppendSegment (HPS.SegmentKey in_style_source, HPS.ConditionalExpression in_conditional)

Appends a conditional expression to an existing style or conditional style. If the style does not currently exist, a new conditional style is pushed. Conditional styles are only applied if their condition(s) are satisfied.

Param in_style_source

The segment to use as the source for the attributes that should be styled.

Param in_conditional

A conditional expression that must be satisfied in order for the style to be applied.

Return

a StyleKey that can be used to interact with the style.

HPS.StyleKey AppendSegment (HPS.SegmentKey in_style_source, HPS.ConditionalExpression in_conditional, HPS.Style.AppendMode in_mode)

Appends a conditional expression to an existing style or conditional style. If the style does not currently exist, a new conditional style is pushed. Conditional styles are only applied if their condition(s) are satisfied.

Param in_style_source

The segment to use as the source for the attributes that should be styled.

Param in_conditional

A conditional expression that must be satisfied in order for the style to be applied.

Param in_mode

The behavior of the conditional expression if another conditional style is currently applied with the same style.

Return

a StyleKey that can be used to interact with the style.

override void Dispose ()

void Flush (HPS.SegmentKey in_style_source)

Removes any styles on the associated segment which refer to the provided style source. The styles will be removed regardless if there is a conditional expression associated with the style or not.

Param in_style_source

The style source used to identify which styles to remove.

void Flush (HPS.SegmentKey in_style_source, HPS.ConditionalExpression in_conditional)

Removes any styles on the associated segment which refer to the provided style source with the provided condition. If a style is found which references the style source and has an associated conditional expression which contains the provided conditional expression, the provided conditional expression will be removed from the conditional expression associated with the style. If removing the provided conditional expression from the style results in the complete removal of the conditional expression for the style, the style itself will be completely removed.

Param in_style_source

The style source used to identify which styles to remove or modify.

Param in_conditional

The conditional expression to remove from styles which refer to the provided style source.

void Flush (string in_style_name)

Removes any styles on the associated segment which refer to the provided style name. The styles will be removed regardless if there is a conditional expression associated with the style or not.

Param in_style_name

The style name used to identify which styles to remove.

void Flush (string in_style_name, HPS.ConditionalExpression in_conditional)

Removes any styles on the associated segment which refer to the provided style name with the provided condition. If a style is found which references the style name and has an associated conditional expression which contains the provided conditional expression, the provided conditional expression will be removed from the conditional expression associated with the style. If removing the provided conditional expression from the style results in the complete removal of the conditional expression for the style, the style itself will be completely removed.

Param in_style_name

The style name used to identify which styles to remove or modify.

Param in_conditional

The conditional expression to remove from styles which refer to the provided style name.

ulong GetCount ()

Returns the number of styles set here.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return

The declared type of the object in question, which may differ from the true, underlying type.

bool Pop ()

Removes the most recent style.

Return

true if a style was present, false otherwise.

bool Pop (out HPS.Style.Type out_type, out HPS.SegmentKey out_segment_source, out string out_style_name, out HPS.ConditionalExpression out_conditional)

Removes the most recent style and gives information about it to the user.

Param out_type

Indicates the type of the style.

Param out_segment_source

If out_type was Segment, this value contains the source segment for the style.

Param out_style_name

If out_type was Named, this value contains the name of the style (defined in a portfolio).

Param out_conditional

The conditions, if any, set on the style when it was applied.

Return

true if a style was present, false otherwise.

HPS.StyleKey PushNamed (string in_style_name)

Adds a named style to the top of the style stack. Existing styles are unmodified but styles on top take precedence if there are duplicate settings.

HPS.StyleKey PushNamed (string in_style_name, HPS.ConditionalExpression in_conditional)

Adds a conditional named style to the top of the style stack. Existing styles are unmodified but styles on top take precedence if there are duplicate settings. Conditional styles are only applied if their condition(s) are satisfied.

Param in_style_name

The name of the named style which should be defined in an accessible portfolio.

Param in_conditional

A conditional expression that must be satisfied in order for the style to be applied.

Return

a StyleKey that can be used to interact with the style.

HPS.StyleKey PushSegment (HPS.SegmentKey in_style_source)

Creates a new style based on in_style_source and places it on the top of the style stack. Existing styles are unmodified but styles on top take precedence if there are duplicate settings.

Param in_style_source

The segment to use as the source for the attributes that should be styled.

Return

a StyleKey that can be used to interact with the style.

HPS.StyleKey PushSegment (HPS.SegmentKey in_style_source, HPS.ConditionalExpression in_conditional)

Creates a new style based on in_style_source and places it on the top of the style stack. Existing styles are unmodified but styles on top take precedence if there are duplicate settings.

Param in_style_source

The segment to use as the source for the attributes that should be styled.

Param in_conditional

A conditional expression that must be satisfied in order for the style to be applied.

Return

a StyleKey that can be used to interact with the style.

void Set (HPS.Style.Type[] in_types, HPS.SegmentKey[] in_segment_sources, string[] in_style_names)

void Set (HPS.Style.Type[] in_types, HPS.SegmentKey[] in_segment_sources, string[] in_style_names, HPS.ConditionalExpression[] in_conditions)

Sets a collection of styles, replacing any existing styles.

Param in_types

Indicates the type of each style.

Param in_segment_sources

For each entry, if in_type was Segment, this value must contain the source segment for the style.

Param in_style_names

For each entry, if in_type was Named, this value must contain the name of the style (defined in a portfolio).

Param in_conditions

The conditions to set on each style.

HPS.StyleKey SetNamed (string in_style_name)

Sets in_style_name as the only active style, replacing any existing styles.

Param in_style_name

The name of the style to apply. If the name does not exist in the active portfolio, no style is applied.

HPS.StyleKey SetNamed (string in_style_name, HPS.ConditionalExpression in_conditional)

Sets in_style_name as the only active style, replacing any existing styles.

Param in_style_name

The name of the style to apply. If the name does not exist in the active portfolio, no style is applied.

Param in_conditional

A condition or conditions that must be met for a style to be activated.

HPS.StyleKey SetSegment (HPS.SegmentKey in_style_source)

Sets in_style_source as the only active style, replacing any existing styles.

Param in_style_source

A segment containing attributes that should be styled.

HPS.StyleKey SetSegment (HPS.SegmentKey in_style_source, HPS.ConditionalExpression in_conditional)

Sets in_style_source as the only active style, replacing any existing styles.

Param in_style_source

A segment containing attributes that should be styled.

Param in_conditional

A condition or conditions that must be met for a style to be activated.

bool Show (out HPS.Style.Type[] out_types, out HPS.SegmentKey[] out_segment_sources, out string[] out_style_names, out HPS.ConditionalExpression[] out_conditions)

bool Show (out HPS.StyleKey[] out_styles)

Shows the all styles on this segment.

Param out_styles

The StyleKey for each style on this segment.

Return

true if any style was present, false otherwise.

bool ShowAllNamed (out HPS.StyleKey[] out_styles)

Shows the all named styles on this segment.

Param out_styles

The StyleKey for each named style on this segment.

Return

true if any named style was present, false otherwise.

bool ShowAllNamed (out string[] out_names, out HPS.ConditionalExpression[] out_conditions)

bool ShowAllSegment (out HPS.SegmentKey[] out_segments, out HPS.ConditionalExpression[] out_conditions)

Shows all segment styles on this segment.

Param out_segments

Keys to all segments styled onto this segment.

Param out_conditions

The conditions, if any, set on each style when it was applied.

Return

true if any style of the correct type was present, false otherwise.

bool ShowAllSegment (out HPS.StyleKey[] out_styles)

Shows the all segment styles on this segment.

Param out_styles

The StyleKey for each segment style on this segment.

Return

true if any segment style was present, false otherwise.

bool ShowTop (out HPS.Style.Type out_type, out HPS.SegmentKey out_segment_source, out string out_style_name, out HPS.ConditionalExpression out_conditional)

Shows the most recent style applied to this segment.

Param out_type

Indicates the type of the style.

Param out_segment_source

If out_type was Style.Type.Segment, this value contains the source segment for the style.

Param out_style_name

If out_type was Style.Type.Named, this value contains the name of the style (defined in a portfolio).

Param out_conditional

The conditions, if any, set on the style when it was applied.

Return

true if a style was present, false otherwise.

bool ShowTop (out HPS.StyleKey out_style)

Shows the most recent style applied to this segment.

Param out_style

The StyleKey for the most recent style applied to this segment.

Return

true if a style was present, false otherwise.

StyleControl (HPS.SegmentKey in_seg)

Initializes a control tied to the segment in_seg.

StyleControl (HPS.StyleControl in_that)

Initializes a control tied to the same object as in_that.

void UnsetAllNamed ()

Unsets all named styles on this segment.

void UnsetAllSegment ()

Unsets all segment styles on this segment.

void UnsetEverything ()

Unsets all styles on this segment.

void UnsetTop ()

Unsets the most recent style on this segment.