QPx_GetAreaFlags

QPx_GetAreaFlags(areaRef; areaRef):error
areaRef Longint QPix area reference
areaFlags Longint Area flags
error Longint Error result

Get various configuration options of a QPix plug-in area

The QPix plug-in area is specified by areaRef. If areaRef is not a valid QPix plug-in area reference, qpx_paramErr is returned.

Parameter areaFlags receives a set of flags. The received value can be tested for specific options by bitwise "AND" of any of the mask constants. Alternatively, you can test individual bits of the areaFlags parameter using 4D's "Bit test" (??) bitwise operator. Use the flag constants to address specific flags:

qpx_ModifiableFlag 2 Modifiable area content
qpx_TabableFlag 3 Tabbable area
qpx_DisplayNaturalSizeFlag 4 Display natural size of hi-res images
qpx_HideHorzScrollFlag 5 Hide horizontal scrollbar
qpx_HideVertScrollFlag 6 Hide vertical scrollbar
qpx_ModifiableMask 4 Mask for modifiable area property
qpx_TabableMask 8 Mask for tabbable property
qpx_DisplayNaturalSizeMask 16 Mask for natural size property
qpx_HideHorzScrollMask 32 Mask for hiding horizontal scrollbar
qpx_HideVertScrollMask 64 Mask for hiding vertical scrollbar

Example

   // Toggle the display of natural size

C_LONGINT($error)
C_LONGINT($areaFlags)

$error:=QPx_GetAreaFlags (gQPixArea;$areaFlags)

If ($error=qpx_noErr)
   
   If ($areaFlags ?? qpx_DisplayNaturalSizeFlag)
      $areaFlags:=$areaFlags ?- qpx_DisplayNaturalSizeFlag
   Else 
      $areaFlags:=$areaFlags ?+ qpx_DisplayNaturalSizeFlag
   End if 
   
   $error:=QPx_SetAreaFlags (gQPixArea;$areaFlags)
   
End if 

Related commands

QPx_SetAreaFlags Configure various options of a QPix plug-in area