REFERENCE MANUAL
The StyleControl class is a smart pointer that is tied to a database object. More...
Public Member Functions | |
HPS.StyleKey | AppendNamed (string in_style_name, HPS.Condition in_condition, HPS.Style.AppendMode mode) |
Appends condition to an existing condition if matching style exists else adds a new named style to the top of the style stack. More... | |
HPS.StyleKey | AppendNamed (string in_style_name, HPS.Condition in_condition) |
Appends condition to an existing condition if matching style exists else adds a new named style to the top of the style stack. More... | |
HPS.StyleKey | AppendSegment (HPS.SegmentKey in_style_source, HPS.Condition in_condition, HPS.Style.AppendMode mode) |
Appends condition to an existing condition if matching style exists else adds a new a new style based on in_style_source and places it on the top of the style stack. More... | |
HPS.StyleKey | AppendSegment (HPS.SegmentKey in_style_source, HPS.Condition in_condition) |
Appends condition to an existing condition if matching style exists else adds a new a new style based on in_style_source and places it on the top of the style stack. More... | |
override void | Dispose () |
void | Flush (HPS.SegmentKey in_style_source) |
Removes any styles on the associated segment which refer to the provided style source. More... | |
void | Flush (HPS.SegmentKey in_style_source, HPS.Condition in_condition) |
Removes any styles on the associated segment which refer to the provided style source with the provided condition. More... | |
void | Flush (string in_style_name) |
Removes any styles on the associated segment which refer to the provided style name. More... | |
void | Flush (string in_style_name, HPS.Condition in_condition) |
Removes any styles on the associated segment which refer to the provided style name with the provided condition. More... | |
ulong | GetCount () |
Returns the number of styles set here. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
bool | Pop () |
Removes the most recent style. More... | |
bool | Pop (out HPS.Style.Type out_type, out HPS.SegmentKey out_segment_source, out string out_style_name, out HPS.Condition out_condition) |
Removes the most recent style and gives information about it to the user. More... | |
HPS.StyleKey | PushNamed (string in_style_name) |
Adds a named style to the top of the style stack. More... | |
HPS.StyleKey | PushNamed (string in_style_name, HPS.Condition in_condition) |
Adds a named style to the top of the style stack. More... | |
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. More... | |
HPS.StyleKey | PushSegment (HPS.SegmentKey in_style_source, HPS.Condition in_condition) |
Creates a new style based on in_style_source and places it on the top of the style stack. More... | |
void | Set (HPS.Style.Type[] in_types, HPS.SegmentKey[] in_segment_sources, string[] in_style_names, HPS.Condition[] in_conditions) |
Sets a collection of styles, replacing any existing styles. More... | |
void | Set (HPS.Style.Type[] in_types, HPS.SegmentKey[] in_segment_sources, string[] in_style_names) |
Sets a collection of styles, replacing any existing styles. More... | |
HPS.StyleKey | SetNamed (string in_style_name) |
Sets in_style_name as the only active style, replacing any existing styles. More... | |
HPS.StyleKey | SetNamed (string in_style_name, HPS.Condition in_condition) |
Sets in_style_name as the only active style, replacing any existing styles. More... | |
HPS.StyleKey | SetSegment (HPS.SegmentKey in_style_source) |
Sets in_style_source as the only active style, replacing any existing styles. More... | |
HPS.StyleKey | SetSegment (HPS.SegmentKey in_style_source, HPS.Condition in_condition) |
Sets in_style_source as the only active style, replacing any existing styles. More... | |
bool | Show (out HPS.Style.Type[] out_types, out HPS.SegmentKey[] out_segment_sources, out string[] out_style_names, out HPS.Condition[] out_conditions) |
Shows all styles on this segment. More... | |
bool | Show (out HPS.StyleKey[] out_styles) |
Shows the all styles on this segment. More... | |
bool | ShowAllNamed (out string[] out_names, out HPS.Condition[] out_conditions) |
Shows all named styles on this segment. More... | |
bool | ShowAllNamed (out HPS.StyleKey[] out_styles) |
Shows the all named styles on this segment. More... | |
bool | ShowAllSegment (out HPS.SegmentKey[] out_segments, out HPS.Condition[] out_conditions) |
Shows all segment styles on this segment. More... | |
bool | ShowAllSegment (out HPS.StyleKey[] out_styles) |
Shows the all segment styles on this segment. More... | |
bool | ShowTop (out HPS.Style.Type out_type, out HPS.SegmentKey out_segment_source, out string out_style_name, out HPS.Condition out_condition) |
Shows the most recent style applied to this segment. More... | |
bool | ShowTop (out HPS.StyleKey out_style) |
Shows the most recent style applied to this segment. More... | |
StyleControl (HPS.SegmentKey in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
StyleControl (HPS.StyleControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
void | UnsetAllNamed () |
Unsets all named styles on this segment. More... | |
void | UnsetAllSegment () |
Unsets all segment styles on this segment. More... | |
void | UnsetEverything () |
Unsets all styles on this segment. More... | |
void | UnsetTop () |
Unsets the most recent style on this segment. More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The StyleControl class is a smart pointer that is tied to a database object.
Controls are used for manipulating settings within the database.
HPS.StyleControl.StyleControl | ( | HPS.SegmentKey | in_seg | ) |
Initializes a control tied to the segment in_seg.
HPS.StyleControl.StyleControl | ( | HPS.StyleControl | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS.StyleKey HPS.StyleControl.AppendNamed | ( | string | in_style_name, |
HPS.Condition | in_condition, | ||
HPS.Style.AppendMode | mode | ||
) |
Appends condition to an existing condition if matching style exists else adds a new named style to the top of the style stack.
HPS.StyleKey HPS.StyleControl.AppendNamed | ( | string | in_style_name, |
HPS.Condition | in_condition | ||
) |
Appends condition to an existing condition if matching style exists else adds a new named style to the top of the style stack.
HPS.StyleKey HPS.StyleControl.AppendSegment | ( | HPS.SegmentKey | in_style_source, |
HPS.Condition | in_condition, | ||
HPS.Style.AppendMode | mode | ||
) |
Appends condition to an existing condition if matching style exists else adds a new a new style based on in_style_source and places it on the top of the style stack.
HPS.StyleKey HPS.StyleControl.AppendSegment | ( | HPS.SegmentKey | in_style_source, |
HPS.Condition | in_condition | ||
) |
Appends condition to an existing condition if matching style exists else adds a new a new style based on in_style_source and places it on the top of the style stack.
void HPS.StyleControl.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.
in_style_source | The style source used to identify which styles to remove. |
void HPS.StyleControl.Flush | ( | HPS.SegmentKey | in_style_source, |
HPS.Condition | in_condition | ||
) |
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.
in_style_source | The style source used to identify which styles to remove or modify. |
in_condition | The conditional expression to remove from styles which refer to the provided style source. |
void HPS.StyleControl.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.
in_style_name | The style name used to identify which styles to remove. |
void HPS.StyleControl.Flush | ( | string | in_style_name, |
HPS.Condition | in_condition | ||
) |
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.
in_style_name | The style name used to identify which styles to remove or modify. |
in_condition | The conditional expression to remove from styles which refer to the provided style name. |
ulong HPS.StyleControl.GetCount | ( | ) |
Returns the number of styles set here.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
bool HPS.StyleControl.Pop | ( | ) |
Removes the most recent style.
bool HPS.StyleControl.Pop | ( | out HPS.Style.Type | out_type, |
out HPS.SegmentKey | out_segment_source, | ||
out string | out_style_name, | ||
out HPS.Condition | out_condition | ||
) |
Removes the most recent style and gives information about it to the user.
out_type | Indicates the type of the style. |
out_segment_source | If out_type was Segment, this value contains the source segment for the style. |
out_style_name | If out_type was Named, this value contains the name of the style (defined in a portfolio). |
out_condition | The conditions, if any, set on the style when it was applied. |
HPS.StyleKey HPS.StyleControl.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 HPS.StyleControl.PushNamed | ( | string | in_style_name, |
HPS.Condition | in_condition | ||
) |
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 HPS.StyleControl.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.
HPS.StyleKey HPS.StyleControl.PushSegment | ( | HPS.SegmentKey | in_style_source, |
HPS.Condition | in_condition | ||
) |
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.
void HPS.StyleControl.Set | ( | HPS.Style.Type[] | in_types, |
HPS.SegmentKey[] | in_segment_sources, | ||
string[] | in_style_names, | ||
HPS.Condition[] | in_conditions | ||
) |
Sets a collection of styles, replacing any existing styles.
in_count | The length of all arrays |
in_types | Indicates the type of each style. |
in_segment_sources | For each entry, if in_type was Segment, this value must contain the source segment for the style. |
in_style_names | For each entry, if in_type was Named, this value must contain the name of the style (defined in a portfolio). |
in_conditions | The conditions, if any, to set on each style. Passing a null pointer indicates no conditions are requested. |
void HPS.StyleControl.Set | ( | HPS.Style.Type[] | in_types, |
HPS.SegmentKey[] | in_segment_sources, | ||
string[] | in_style_names | ||
) |
Sets a collection of styles, replacing any existing styles.
in_types | Indicates the type of each style. |
in_segment_sources | For each entry, if in_type was Segment, this value must contain the source segment for the style. |
in_style_names | For each entry, if in_type was Named, this value must contain the name of the style (defined in a portfolio). |
HPS.StyleKey HPS.StyleControl.SetNamed | ( | string | in_style_name | ) |
Sets in_style_name as the only active style, replacing any existing styles.
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 HPS.StyleControl.SetNamed | ( | string | in_style_name, |
HPS.Condition | in_condition | ||
) |
Sets in_style_name as the only active style, replacing any existing styles.
in_style_name | The name of the style to apply. If the name does not exist in the active portfolio, no style is applied. |
in_condition | A condition or conditions that must be met for a style to be activated. |
HPS.StyleKey HPS.StyleControl.SetSegment | ( | HPS.SegmentKey | in_style_source | ) |
Sets in_style_source as the only active style, replacing any existing styles.
in_style_source | A segment containing attributes that should be styled. |
HPS.StyleKey HPS.StyleControl.SetSegment | ( | HPS.SegmentKey | in_style_source, |
HPS.Condition | in_condition | ||
) |
Sets in_style_source as the only active style, replacing any existing styles.
in_style_source | A segment containing attributes that should be styled. |
in_condition | A condition or conditions that must be met for a style to be activated. |
bool HPS.StyleControl.Show | ( | out HPS.Style.Type[] | out_types, |
out HPS.SegmentKey[] | out_segment_sources, | ||
out string[] | out_style_names, | ||
out HPS.Condition[] | out_conditions | ||
) |
Shows all styles on this segment.
out_types | Indicates the type of each style. |
out_segment_sources | For each entry, if out_type was <ref refid="class_h_p_s_1_1_style_1a1520cc48e274221c9f87e3e80378240aa4b77e2a9d8e9cfc299f504b32d6e3d2b" kindref="member">Style::Type::Segment</ref>, this value contains the source segment for the style. |
out_style_names | For each entry, if out_type was <ref refid="class_h_p_s_1_1_style_1a1520cc48e274221c9f87e3e80378240aa02a7d85bf0d59dff6a850fb5d7dbbe01" kindref="member">Style::Type::Named</ref>, this value contains the name of the style (defined in a portfolio). |
out_conditions | The conditions, if any, set on each style when it was applied. |
bool HPS.StyleControl.Show | ( | out HPS.StyleKey[] | out_styles | ) |
Shows the all styles on this segment.
out_styles | The <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref> for each style on this segment. |
bool HPS.StyleControl.ShowAllNamed | ( | out string[] | out_names, |
out HPS.Condition[] | out_conditions | ||
) |
Shows all named styles on this segment.
out_names | Names of all named styles set on this segment. |
out_conditions | The conditions, if any, set on each style when it was applied. |
bool HPS.StyleControl.ShowAllNamed | ( | out HPS.StyleKey[] | out_styles | ) |
Shows the all named styles on this segment.
out_styles | The <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref> for each named style on this segment. |
bool HPS.StyleControl.ShowAllSegment | ( | out HPS.SegmentKey[] | out_segments, |
out HPS.Condition[] | out_conditions | ||
) |
Shows all segment styles on this segment.
out_segments | Keys to all segments styled onto this segment. |
out_conditions | The conditions, if any, set on each style when it was applied. |
bool HPS.StyleControl.ShowAllSegment | ( | out HPS.StyleKey[] | out_styles | ) |
Shows the all segment styles on this segment.
out_styles | The <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref> for each segment style on this segment. |
bool HPS.StyleControl.ShowTop | ( | out HPS.Style.Type | out_type, |
out HPS.SegmentKey | out_segment_source, | ||
out string | out_style_name, | ||
out HPS.Condition | out_condition | ||
) |
Shows the most recent style applied to this segment.
out_type | Indicates the type of the style. |
out_segment_source | If out_type was <ref refid="class_h_p_s_1_1_style_1a1520cc48e274221c9f87e3e80378240aa4b77e2a9d8e9cfc299f504b32d6e3d2b" kindref="member">Style::Type::Segment</ref>, this value contains the source segment for the style. |
out_style_name | If out_type was <ref refid="class_h_p_s_1_1_style_1a1520cc48e274221c9f87e3e80378240aa02a7d85bf0d59dff6a850fb5d7dbbe01" kindref="member">Style::Type::Named</ref>, this value contains the name of the style (defined in a portfolio). |
out_condition | The conditions, if any, set on the style when it was applied. |
bool HPS.StyleControl.ShowTop | ( | out HPS.StyleKey | out_style | ) |
Shows the most recent style applied to this segment.
out_style | The <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref> for the most recent style applied to this segment. |
void HPS.StyleControl.UnsetAllNamed | ( | ) |
Unsets all named styles on this segment.
void HPS.StyleControl.UnsetAllSegment | ( | ) |
Unsets all segment styles on this segment.
void HPS.StyleControl.UnsetEverything | ( | ) |
Unsets all styles on this segment.
void HPS.StyleControl.UnsetTop | ( | ) |
Unsets the most recent style on this segment.