Mako 7.3.0 API
IDOMNodeFlags Class Referenceabstract

A collection of bit flags used to signal various conditions of the node. For example, the eNodeRenderFlag flag identifies nodes that require rendering. More...

#include <idomnode.h>

Public Types

enum  DOMNodeFlags {
  eNodeRenderFlag = 8 , eNodeUnpackFlag = 9 , eNodeDirtyFlag = 10 , eNodeInterestingFlag = 11 ,
  eNodeSelectedFlag = 15 , eNodeUserFlag = 16
}
 DOM node flag enumeration. More...
 

Public Member Functions

virtual ~IDOMNodeFlags ()
 Virtual destructor.
 
virtual bool get (uint32 position) const =0
 Tests whether the bit at a specified position is set to 1. More...
 
virtual void set (uint32 position, bool value=true)=0
 Sets the bit at the specified position to the specified value. More...
 

Detailed Description

A collection of bit flags used to signal various conditions of the node. For example, the eNodeRenderFlag flag identifies nodes that require rendering.

The IDOMNodeFlags class keeps primary, secondary and tertiary flags. The first eight bits (0..7) are reserved for EDL private use - OEM user cannot change these bits. The next eight bits (8..15) are reserved for EDL public use - an OEM user can change these bits and the bit's meaning is documented. The next sixteen bits (16..32) are reserved for OEM usage.

Member Enumeration Documentation

◆ DOMNodeFlags

DOM node flag enumeration.

  • The first eight bits (0..7) are reserved for EDL private use - OEM user cannot change these bits.
  • The next eight bits (8..15) are reserved for EDL public use - OEM user can change these bits, and their meaning is documented. For example, bit 8 is the eNodeRenderFlag.
  • The next sixteen bits (16..32) are reserved for OEM usage
Enumerator
eNodeRenderFlag 

Marks a node as not to be rendered

eNodeUnpackFlag 

Marks a node as unpacked

eNodeDirtyFlag 

Marks a node as dirty (i.e with changed content)

eNodeInterestingFlag 

Marks a node as interesting for rendering purposes See IJawsRenderer for details.

eNodeSelectedFlag 

Marks a node as selected

eNodeUserFlag 

Marks a node with a user flag whose meaning is determined elsewhere

Member Function Documentation

◆ get()

virtual bool IDOMNodeFlags::get ( uint32  position) const
pure virtual

Tests whether the bit at a specified position is set to 1.

Parameters
positionThe bit position to test.
Returns
bool Returns true if the flag bit is set to 1, false if it is set to zero.

◆ set()

virtual void IDOMNodeFlags::set ( uint32  position,
bool  value = true 
)
pure virtual

Sets the bit at the specified position to the specified value.

Parameters
positionThe bit position to set.
valueThe bit value to set.

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