Image area
|
QPix Command Reference
Image area
|
|
| QPx_GetAreaStyle(areaRef; displayFormat; frameStyle; focusRing):error | |||
|
|
areaRef | Longint | QPix area reference |
|
|
displayFormat | Longint | Display format |
|
|
frameStyle | Longint | Frame style |
|
|
focusRing | Longint | Focus ring style |
|
|
error | Longint | Error result |
Returns the visual appearance configuration 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 displayFormat receives the plug-in area display format. It can be one of the following constants:
| qpx_PictScrolling | 0 | Picture has scrollbars |
| qpx_PictTruncCentered | 1 | Picture is truncated to the area rectangle size and centered in it |
| qpx_PictScaledToFit | 2 | Picture is scaled up or down separately across each dimension to fit the current area rectangle |
| qpx_PictTruncNonCenter | 4 | Picture is truncated to the area rectangle size and placed top left |
| qpx_PictScaledToFitProp | 5 | Picture is scaled down proportionally to fit the current area rectangle and placed top left |
| qpx_PictScaledToFitPropCenter | 6 | Picture is scaled down proportionally to fit the current area rectangle and centered |
Parameter frameStyle receives the area frame style. It can be one of the following constants:
| qpx_PlainFrame | 0 | Puts a black one-pixel frame around the area |
| qpx_SunkenFrame | 1 | Puts a sunken-style frame around the area |
| qpx_NoneFrame | 3 | No frame |
Parameter focusRing receives the style of the area focus ring. It can be one of the following constants:
| qpx_NoFocus | 0 | No focus indication |
| qpx_SmokedFocus | 1 | Cool, smoke-style focus indication |
| qpx_SystemFocus | 2 | Focus indication using the system hilite color |
| qpx_PlainFocus | 3 | Focus indication using a plain frame |
Related commands
| QPx_SetAreaStyle | Configures the visual appearance of a QPix plug-in area |