The StyleControl class is a smart pointer that is tied to a database object. Controls are used for manipulating settings within the database. More...
Public Member Functions | |
override void | Dispose () |
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... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
ulong | GetCount () |
Returns the number of styles set here. More... | |
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. More... | |
HPS.StyleKey | 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. More... | |
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 | 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. 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. Existing styles are unmodified but styles on top take precedence if there are duplicate settings. 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... | |
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... | |
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. 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. 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. More... | |
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. 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. 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. 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... | |
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... | |
void | UnsetTop () |
Unsets the most recent style on this segment. More... | |
void | UnsetAllSegment () |
Unsets all segment styles on this segment. More... | |
void | UnsetAllNamed () |
Unsets all named styles on this segment. More... | |
void | UnsetEverything () |
Unsets all 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... | |
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 | 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 | 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... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object that) | |
HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The StyleControl class is a smart pointer that is tied to a database object. Controls are used for manipulating settings within the database.
|
inline |
Initializes a control tied to the segment in_seg.
|
inline |
Initializes a control tied to the same object as in_that.
|
inline |
Appends condition to an existing condition if matching style exists else adds a new named style to the top of the style stack.
|
inline |
Appends condition to an existing condition if matching style exists else adds a new named style to the top of the style stack.
|
inline |
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.
|
inline |
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.
|
inline |
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. |
|
inline |
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. |
|
inline |
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. |
|
inline |
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. |
|
inline |
Returns the number of styles set here.
|
inlinevirtual |
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.
|
inline |
Removes the most recent style.
|
inline |
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. |
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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). |
in_conditions | The conditions to set on each style. |
|
inline |
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). |
|
inline |
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. |
|
inline |
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. |
|
inline |
Sets in_style_source as the only active style, replacing any existing styles.
in_style_source | A segment containing attributes that should be styled. |
|
inline |
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. |
|
inline |
Shows all styles on this segment.
out_types | Indicates the type of each style. |
out_segment_sources | For each entry, if out_type was Style::Type::Segment, this value contains the source segment for the style. |
out_style_names | For each entry, if out_type was Style::Type::Named, 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. |
|
inline |
Shows the all styles on this segment.
out_styles | The StyleKey for each style on this segment. |
|
inline |
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. |
|
inline |
Shows the all named styles on this segment.
out_styles | The StyleKey for each named style on this segment. |
|
inline |
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. |
|
inline |
Shows the all segment styles on this segment.
out_styles | The StyleKey for each segment style on this segment. |
|
inline |
Shows the most recent style applied to this segment.
out_type | Indicates the type of the style. |
out_segment_source | If out_type was Style::Type::Segment, this value contains the source segment for the style. |
out_style_name | If out_type was Style::Type::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. |
|
inline |
Shows the most recent style applied to this segment.
out_style | The StyleKey for the most recent style applied to this segment. |
|
inline |
Unsets all named styles on this segment.
|
inline |
Unsets all segment styles on this segment.
|
inline |
Unsets all styles on this segment.
|
inline |
Unsets the most recent style on this segment.