QPx_GetAreaFlags

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

Returns 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_MiniScrollbarsFlag 1 Narrower scrollbars
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_MiniScrollBarsMask 2 Mask for mini scrollbar property
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
qpx_PropScrollBarsFlag 9 Proportional scrollbars
qpx_LiveScrollingFlag 10 Live scrolling
qpx_PropScrollBarsMask 0x0200 Proportional scrollbars mask
qpx_LiveScrollingMask 0x0400 Live scrolling mask
qpx_SmoothZoomingFlag 11 Smooth zooming
qpx_SmoothZoomingMask 0x0800 Smooth zooming mask

Example

  `Toggle mini scrollbars
 
C_LONGINT($error)
C_LONGINT($areaFlags)
 
$error:=QPx_GetAreaFlags (gQPixArea;$areaFlags)
 
If ($error=qpx_noErr)
 
  If ($areaFlags ?? qpx_MiniScrollbarsFlag)
    $areaFlags:=$areaFlags ?- qpx_MiniScrollbarsFlag
  Else
    $areaFlags:=$areaFlags ?+ qpx_MiniScrollbarsFlag
  End if
 
  $error:=QPx_SetAreaFlags (gQPixArea;$areaFlags)
 
End if
 

Related commands

QPx_SetAreaFlags Configures various options of a QPix plug-in area

QPix © Escape
Generated by QDoc 2.8 on Wed, Feb 17, 2010 17:43:59