XII Release 0.1.0
Loading...
Searching...
No Matches
xiiDynamicBitflags Class Reference

Stores the valid values and names for 'dynamic' bitflags. More...

#include <DynamicBitflags.h>

Public Member Functions

const xiiMap< xiiUInt64, xiiString > & GetAllValidValues () const
 Returns all bitflag values and current names.
 
void Clear ()
 Resets stored values.
 
void SetValueAndName (xiiUInt32 uiBitPos, xiiStringView sName)
 Sets the name for the given bit position.
 
void RemoveValue (xiiUInt32 uiBitPos)
 Removes a value, if it exists.
 
bool IsValueValid (xiiUInt32 uiBitPos) const
 Returns whether a certain value is known.
 
bool TryGetValueName (xiiUInt32 uiBitPos, xiiStringView &out_sName) const
 Returns the name for the given value.
 

Static Public Member Functions

static xiiDynamicBitflagsGetDynamicBitflags (xiiStringView sName)
 Returns a xiiDynamicBitflags under the given name. Creates a new one, if the name has not been used before.
 

Detailed Description

Stores the valid values and names for 'dynamic' bitflags.

The names and valid values for dynamic bitflags may change due to user configuration changes. The UI should show these user specified names without restarting the tool.

Call the static function GetDynamicBitflags() to create or get the xiiDynamicBitflags for a specific type.


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