Public Types | Public Member Functions | List of all members
LayoutFlags< Enum > Class Template Reference

LayoutFlags - Creates a "Flags" class out of an enum with constructors and operator overloading. More...

#include <LayoutFlags.h>

Public Types

typedef Enum enum_type
 

Public Member Functions

 LayoutFlags (const LayoutFlags &f)
 Constructs a LayoutFlags object given another LayoutFlags. More...
 
 LayoutFlags (Enum f)
 Constructs a LayoutFlags object given an Enum. More...
 
 LayoutFlags (Zero=0)
 Constructs a LayoutFlags object given a void*. More...
 
 LayoutFlags (LayoutFlag f)
 Constructs a LayoutFlags object given a LayoutFlag. More...
 
LayoutFlagsoperator= (const LayoutFlags &f)
 Operator overload for =. More...
 
LayoutFlagsoperator&= (int mask)
 Operator overload for &=. More...
 
LayoutFlagsoperator&= (UInt mask)
 Operator overload for &=. More...
 
LayoutFlagsoperator|= (LayoutFlags f)
 Operator overload for |=. More...
 
LayoutFlagsoperator|= (Enum f)
 Operator overload for |=. More...
 
LayoutFlagsoperator^= (LayoutFlags f)
 Operator overload for ^=. More...
 
LayoutFlagsoperator^= (Enum f)
 Operator overload for ^=. More...
 
LayoutFlagsoperator^= (int mask)
 Operator overload for ^=. More...
 
 operator int () const
 (int) cast overload More...
 
LayoutFlags operator| (LayoutFlags f) const
 Operator overload for |. More...
 
LayoutFlags operator| (Enum f) const
 Operator overload for |. More...
 
LayoutFlags operator^ (LayoutFlags f) const
 Operator overload for ^. More...
 
LayoutFlags operator^ (Enum f) const
 Operator overload for ^. More...
 
LayoutFlags operator& (int mask) const
 Operator overload for &. More...
 
LayoutFlags operator& (UInt mask) const
 Operator overload for &. More...
 
LayoutFlags operator& (Enum f) const
 Operator overload for &. More...
 
LayoutFlags operator~ () const
 Operator overload for ~. More...
 
bool operator! () const
 Operator overload for ! More...
 
bool testFlag (Enum f) const
 Tests the flag with the given Enum. More...
 

Detailed Description

template<typename Enum>
class LayoutFlags< Enum >

LayoutFlags - Creates a "Flags" class out of an enum with constructors and operator overloading.

Member Typedef Documentation

typedef Enum enum_type

Constructor & Destructor Documentation

LayoutFlags ( const LayoutFlags< Enum > &  f)

Constructs a LayoutFlags object given another LayoutFlags.

LayoutFlags ( Enum  f)

Constructs a LayoutFlags object given an Enum.

LayoutFlags ( Zero  = 0)

Constructs a LayoutFlags object given a void*.

Constructs a LayoutFlags object given a LayoutFlag.

Member Function Documentation

operator int ( ) const

(int) cast overload

bool operator! ( ) const

Operator overload for !

LayoutFlags operator& ( int  mask) const

Operator overload for &.

LayoutFlags operator& ( UInt  mask) const

Operator overload for &.

LayoutFlags operator& ( Enum  f) const

Operator overload for &.

LayoutFlags& operator&= ( int  mask)

Operator overload for &=.

LayoutFlags& operator&= ( UInt  mask)

Operator overload for &=.

LayoutFlags& operator= ( const LayoutFlags< Enum > &  f)

Operator overload for =.

LayoutFlags operator^ ( LayoutFlags< Enum >  f) const

Operator overload for ^.

LayoutFlags operator^ ( Enum  f) const

Operator overload for ^.

LayoutFlags& operator^= ( LayoutFlags< Enum >  f)

Operator overload for ^=.

LayoutFlags& operator^= ( Enum  f)

Operator overload for ^=.

LayoutFlags& operator^= ( int  mask)

Operator overload for ^=.

LayoutFlags operator| ( LayoutFlags< Enum >  f) const

Operator overload for |.

LayoutFlags operator| ( Enum  f) const

Operator overload for |.

LayoutFlags& operator|= ( LayoutFlags< Enum >  f)

Operator overload for |=.

LayoutFlags& operator|= ( Enum  f)

Operator overload for |=.

LayoutFlags operator~ ( ) const

Operator overload for ~.

bool testFlag ( Enum  f) const

Tests the flag with the given Enum.


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

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.