Public Member Functions | Static Public Member Functions | List of all members
HPS::HighlightOptionsKit Class Reference

#include <hps.h>

Inheritance diagram for HPS::HighlightOptionsKit:
HPS::Object

Public Member Functions

 HighlightOptionsKit ()
 
 HighlightOptionsKit (char const *in_style_name)
 
 HighlightOptionsKit (char const *in_style_name, char const *in_secondary_style_name)
 
 HighlightOptionsKit (HighlightOptionsKit const &in_kit)
 
 HighlightOptionsKit (HighlightOptionsKit &&in_that)
 
HighlightOptionsKitoperator= (HighlightOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
void Set (HighlightOptionsKit const &in_kit)
 
void Show (HighlightOptionsKit &out_kit) const
 
HighlightOptionsKitoperator= (HighlightOptionsKit const &in_kit)
 
bool Empty () const
 
bool Equals (HighlightOptionsKit const &in_kit) const
 
bool operator== (HighlightOptionsKit const &in_kit) const
 
bool operator!= (HighlightOptionsKit const &in_kit) const
 
HighlightOptionsKitSetStyleName (char const *in_style_name)
 
HighlightOptionsKitSetSecondaryStyleName (char const *in_style_name)
 
HighlightOptionsKitSetOverlay (Drawing::Overlay in_overlay)
 
HighlightOptionsKitSetNotification (bool in_state)
 
HighlightOptionsKitUnsetStyleName ()
 
HighlightOptionsKitUnsetSecondaryStyleName ()
 
HighlightOptionsKitUnsetOverlay ()
 
HighlightOptionsKitUnsetNotification ()
 
HighlightOptionsKitUnsetEverything ()
 
bool ShowStyleName (UTF8 &out_style_name) const
 
bool ShowSecondaryStyleName (UTF8 &out_style_name) const
 
bool ShowOverlay (Drawing::Overlay &out_overlay) const
 
bool ShowNotification (bool &out_state) const
 
- Public Member Functions inherited from HPS::Object
 Object (Object const &that)
 
Objectoperator= (Object const &other_object)
 
 Object (Object &&in_that)
 
Objectoperator= (Object &&in_that)
 
HPS::Type Type () const
 
virtual void Reset ()
 
bool HasType (HPS::Type in_mask) const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 

Static Public Member Functions

static HighlightOptionsKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The HighlightOptionsKit class is a user space object. It is used to hold settings needed when performing a highlight or unhighlight. HPS::HighlightOptionsKit::GetDefault() will return a highlight options kit with values found in this table.

Constructor & Destructor Documentation

HPS::HighlightOptionsKit::HighlightOptionsKit ( )

The default constructor creates an empty HighlightOptionsKit object.

HPS::HighlightOptionsKit::HighlightOptionsKit ( char const *  in_style_name)

This constructor creates a HighlightOptionsKit object with the specified style name set on it.

Parameters
in_style_nameThe style name to set on this HighlightOptionsKit.
HPS::HighlightOptionsKit::HighlightOptionsKit ( char const *  in_style_name,
char const *  in_secondary_style_name 
)

This constructor creates a HighlightOptionsKit object with the specified style and secondary style names set on it.

Parameters
in_style_nameThe style name to set on this HighlightOptionsKit.
in_secondary_style_nameThe style name to set on this HighlightOptionsKit.
HPS::HighlightOptionsKit::HighlightOptionsKit ( HighlightOptionsKit const &  in_kit)

The copy constructor creates a new HighlightOptionsKit object that contains the same settings as the source HighlightOptionsKit.

Parameters
in_kitThe source HighlightOptionsKit to copy.
HPS::HighlightOptionsKit::HighlightOptionsKit ( HighlightOptionsKit &&  in_that)

The move constructor creates a HighlightOptionsKit by transferring the underlying impl of the rvalue reference to this HighlightOptionsKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a HighlightOptionsKit to take the impl from.

Member Function Documentation

bool HPS::HighlightOptionsKit::Empty ( ) const
virtual

Indicates whether this HighlightOptionsKit has any values set on it.

Returns
true if no values are set on this HighlightOptionsKit, false otherwise.

Reimplemented from HPS::Object.

bool HPS::HighlightOptionsKit::Equals ( HighlightOptionsKit const &  in_kit) const

Check if the source HighlightOptionsKit is equivalent to this HighlightOptionsKit.

Parameters
in_kitThe source HighlightOptionsKit to compare to this HighlightOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
static HighlightOptionsKit HPS::HighlightOptionsKit::GetDefault ( )
static

Creates a HighlightOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns
A HighlightOptionsKit with the default settings.
HPS::Type HPS::HighlightOptionsKit::ObjectType ( ) const
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::Object.

bool HPS::HighlightOptionsKit::operator!= ( HighlightOptionsKit const &  in_kit) const

Check if the source HighlightOptionsKit is not equivalent to this HighlightOptionsKit.

Parameters
in_kitThe source HighlightOptionsKit to compare to this HighlightOptionsKit.
Returns
true if the objects are not equivalent, false otherwise.
HighlightOptionsKit& HPS::HighlightOptionsKit::operator= ( HighlightOptionsKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this HighlightOptionsKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a HighlightOptionsKit to take the impl from.
Returns
A reference to this HighlightOptionsKit.
HighlightOptionsKit& HPS::HighlightOptionsKit::operator= ( HighlightOptionsKit const &  in_kit)

Copies the source HighlightOptionsKit into this HighlightOptionsKit.

Parameters
in_kitThe source HighlightOptionsKit to copy.
Returns
A reference to this HighlightOptionsKit.
bool HPS::HighlightOptionsKit::operator== ( HighlightOptionsKit const &  in_kit) const

Check if the source HighlightOptionsKit is equivalent to this HighlightOptionsKit.

Parameters
in_kitThe source HighlightOptionsKit to compare to this HighlightOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
void HPS::HighlightOptionsKit::Set ( HighlightOptionsKit const &  in_kit)

Copies the source HighlightOptionsKit into this HighlightOptionsKit.

Parameters
in_kitThe source HighlightOptionsKit to copy.
HighlightOptionsKit& HPS::HighlightOptionsKit::SetNotification ( bool  in_state)

Whether to inject a notification event after highlighting (or unhighlighting).

Parameters
in_stateWhether to inject a notification event after highlighting (or unhighlighting).
Returns
A reference to this HighlightOptionsKit.
See also
Notification default value
HighlightOptionsKit& HPS::HighlightOptionsKit::SetOverlay ( Drawing::Overlay  in_overlay)

Allows highlighting to take place in a segment without triggering a full-screen redraw. If any type of overlay is used, transparency in the highlighted object(s) will be ignored.

Parameters
in_overlayThe type of overlay, if any, to be used.
Returns
A reference to this object.
See also
Overlay default value
HighlightOptionsKit& HPS::HighlightOptionsKit::SetSecondaryStyleName ( char const *  in_style_name)

Sets the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting).

Parameters
in_style_nameUTF8-encoded style name.
Returns
A reference to this HighlightOptionsKit.
HighlightOptionsKit& HPS::HighlightOptionsKit::SetStyleName ( char const *  in_style_name)

Sets the name of the style to apply (or unapply) when highlighting (or unhighlighting).

Parameters
in_style_nameUTF8-encoded style name.
Returns
A reference to this HighlightOptionsKit.
void HPS::HighlightOptionsKit::Show ( HighlightOptionsKit out_kit) const

Copies this HighlightOptionsKit into the given HighlightOptionsKit.

Parameters
out_kitThe HighlightOptionsKit to populate with the contents of this HighlightOptionsKit.
bool HPS::HighlightOptionsKit::ShowNotification ( bool &  out_state) const

Shows the notification setting.

Parameters
out_stateWhether to inject a notification event after highlighting (or unhighlighting).
Returns
true if a notification setting was specified, false otherwise.
bool HPS::HighlightOptionsKit::ShowOverlay ( Drawing::Overlay out_overlay) const

Shows the overlay setting.

Parameters
out_overlayThe type of overlay, if any, used.
Returns
true if the setting is valid, false otherwise.
bool HPS::HighlightOptionsKit::ShowSecondaryStyleName ( UTF8 out_style_name) const

Shows the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting).

Parameters
out_style_nameUTF8-encoded style name.
Returns
true if a style was specified, false otherwise.
bool HPS::HighlightOptionsKit::ShowStyleName ( UTF8 out_style_name) const

Shows the name of the style to apply (or unapply) when highlighting (or unhighlighting).

Parameters
out_style_nameUTF8-encoded style name.
Returns
true if a style was specified, false otherwise.
HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetEverything ( )

Removes all settings from this HighlightOptionsKit.

Returns
A reference to this HighlightOptionsKit.
HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetNotification ( )

Removes the notification setting.

Returns
A reference to this HighlightOptionsKit.
HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetOverlay ( )

Removes an overlay setting.

Returns
A reference to this object.
HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetSecondaryStyleName ( )

Removes the secondary style to apply (or unapply) when highlighting (or unhighlighting).

Returns
A reference to this HighlightOptionsKit.
HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetStyleName ( )

Removes the style to apply (or unapply) when highlighting (or unhighlighting).

Returns
A reference to this HighlightOptionsKit.

The documentation for this class was generated from the following file: