SliceO_Class::..._Toggle

 

SliceO_Class::Flag_Toggle

 

 

This method toggle the value of specific bits in the flag.  For each active windows, there are 4 64 bits flags associated with each instances of the class: "Update_A" and "Update_B" are used to signal that a specific update must be applied to the instance (A is immediate, B is delayed), "Redraw" signal that a specific redraw operation must be applied to the instance, and "Flag" contain information on the state of the instance (such as "Visible", "current"...).

 

The "Toggle" operation can be applied to the current instance, its parent and/or its descendants.

 

So, in order to perform the "Toggle" operation we need to know: for what bit of the flag?  for which window? and is it applied to this instance, its parent of its descendants?

 

 

Syntax

 

void  Flag_Toggle(

          unsigned char mode,

          void * window,

          UInt64 mask

) ;

 

 

Parameters

 

mode

                    This variable is an "OR" of the following values to specified how the changes affect this instances and the connected classes:

 

CLASS_MODE_THIS

The desired flag(s) of this instance are modified.

 

CLASS_MODE_CHILD

The desired flag(s) of the descendants (down to the frame level) of this instance are modified

 

CLASS_MODE_PARENT

The desired flag(s) of the parents of this instance (up to the root level)are modified.

 

CLASS_MODE_VISIBLE

Only affect the flag(s) of visible classes

 

CLASS_MODE_SELECT

Only affect the flag(s) of selected classes

 

CLASS_MODE_CURRENT

Only affect the flag(s) of the current classes

 

window

                    Pointer to the window of interest or one of the following values:

 

CLASS_MODE_ALL

The changes are applied to all windows

 

CLASS_MODE_NONE

The changes are applied to none of the windows (some flags are window independent)

 

CLASS_MODE_CURRENT

The changes are applied only to the currently selected window

 

mask

                    Bit mask of the flag we want to set.

 

 

Return value

 

This method does not return a value.

 

 

Remarks

 

 

Requirements

 

Header:

          sliceO_include.hpp

 

Library:

          sliceO_Structures.lib

 

 

Example

 

 

 

See also