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 | |
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. More... | |
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. More... | |
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. More... | |
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. 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. 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.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. 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.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. More... | |
ulong | GetCount () |
Returns the number of styles set here. 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... | |
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.ConditionalExpression out_conditional) |
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. Existing styles are unmodified but styles on top take precedence if there are duplicate settings. More... | |
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. 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.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. More... | |
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. 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.ConditionalExpression in_conditional) |
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.ConditionalExpression in_conditional) |
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.ConditionalExpression[] 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.ConditionalExpression[] 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.ConditionalExpression[] 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.ConditionalExpression out_conditional) |
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... | |
override 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... | |
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. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The StyleControl class is a smart pointer that is tied to a database object. Controls are used for manipulating settings within the database.
Constructor & Destructor Documentation
|
inline |
Initializes a control tied to the segment in_seg.
|
inline |
Initializes a control tied to the same object as in_that.
Member Function Documentation
|
inline |
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.
- Parameters
-
in_style_name The name of the named style which should be defined in an accessible portfolio. in_conditional A conditional expression that must be satisfied in order for the style to be applied. in_mode The behavior of the conditional expression if another conditional style is currently applied with the same style.
- Returns
- a StyleKey that can be used to interact with the style.
|
inline |
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.
- Parameters
-
in_style_name The name of the named style which should be defined in an accessible portfolio. in_conditional A conditional expression that must be satisfied in order for the style to be applied.
- Returns
- a StyleKey that can be used to interact with the style.
|
inline |
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.
- Parameters
-
in_style_source The segment to use as the source for the attributes that should be styled. in_conditional A conditional expression that must be satisfied in order for the style to be applied. in_mode The behavior of the conditional expression if another conditional style is currently applied with the same style.
- Returns
- a StyleKey that can be used to interact with the style.
|
inline |
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.
- Parameters
-
in_style_source The segment to use as the source for the attributes that should be styled. in_conditional A conditional expression that must be satisfied in order for the style to be applied.
- Returns
- a StyleKey that can be used to interact with the style.
|
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.
- Parameters
-
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.
- Parameters
-
in_style_source The style source used to identify which styles to remove or modify. in_conditional 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.
- Parameters
-
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.
- Parameters
-
in_style_name The style name used to identify which styles to remove or modify. in_conditional 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.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Control.
|
inline |
Removes the most recent style.
- Returns
- true if a style was present, false otherwise.
|
inline |
Removes the most recent style and gives information about it to the user.
- Parameters
-
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_conditional The conditions, if any, set on the style when it was applied.
- Returns
- true if a style was present, false otherwise.
|
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 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.
- Parameters
-
in_style_name The name of the named style which should be defined in an accessible portfolio. in_conditional A conditional expression that must be satisfied in order for the style to be applied.
- Returns
- a StyleKey that can be used to interact with the style.
|
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.
- Parameters
-
in_style_source The segment to use as the source for the attributes that should be styled.
- Returns
- a StyleKey that can be used to interact with the style.
|
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.
- Parameters
-
in_style_source The segment to use as the source for the attributes that should be styled. in_conditional A conditional expression that must be satisfied in order for the style to be applied.
- Returns
- a StyleKey that can be used to interact with the style.
|
inline |
Sets a collection of styles, replacing any existing styles.
- Parameters
-
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.
- Parameters
-
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.
- Parameters
-
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.
- Parameters
-
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_conditional 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.
- Parameters
-
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.
- Parameters
-
in_style_source A segment containing attributes that should be styled. in_conditional A condition or conditions that must be met for a style to be activated.
|
inline |
Shows all styles on this segment.
- Parameters
-
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.
- Returns
- true if any style was present, false otherwise.
|
inline |
Shows the all styles on this segment.
- Parameters
-
out_styles The StyleKey for each style on this segment.
- Returns
- true if any style was present, false otherwise.
|
inline |
Shows all named styles on this segment.
- Parameters
-
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.
- Returns
- true if any style of the correct type was present, false otherwise.
|
inline |
Shows the all named styles on this segment.
- Parameters
-
out_styles The StyleKey for each named style on this segment.
- Returns
- true if any named style was present, false otherwise.
|
inline |
Shows all segment styles on this segment.
- Parameters
-
out_segments Keys to all segments styled onto this segment. out_conditions The conditions, if any, set on each style when it was applied.
- Returns
- true if any style of the correct type was present, false otherwise.
|
inline |
Shows the all segment styles on this segment.
- Parameters
-
out_styles The StyleKey for each segment style on this segment.
- Returns
- true if any segment style was present, false otherwise.
|
inline |
Shows the most recent style applied to this segment.
- Parameters
-
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_conditional The conditions, if any, set on the style when it was applied.
- Returns
- true if a style was present, false otherwise.
|
inline |
Shows the most recent style applied to this segment.
- Parameters
-
out_style The StyleKey for the most recent style applied to this segment.
- Returns
- true if a style was present, false otherwise.
|
inlinevirtual |
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
|
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.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.StyleControl.cs