Separator for organizing widgets
PtWidget → PtBasic → PtSeparator
For more information, see the diagram of the widget hierarchy.
<photon/PtSeparator.h>
PtSeparator provides a separator line with various styles. You should find it handy when creating menus, or for organizing areas that hold a lot of widgets.
Resource | C type | Pt type | Default |
---|---|---|---|
Pt_ARG_SEP_ARM_BITMAP_CURSOR | PhBitmapCursorDescription_t * | Alloc | NULL |
Pt_ARG_SEP_ARM_CURSOR_COLOR | PgColor_t | Scalar | Ph_CURSOR_ DEFAULT_COLOR |
Pt_ARG_SEP_ARM_CURSOR_TYPE | unsigned short | Scalar | Ph_CURSOR_ INHERIT |
Pt_ARG_SEP_DRAG_BOUNDS | PhRect_t | Struct | NULL |
Pt_ARG_SEP_FLAGS | short | Flag | Pt_SEP_ HORIZONTAL |
Pt_ARG_SEP_IMAGE | PhImage_t * | Image | NULL |
Pt_ARG_SEP_IMAGE_H_ALIGN | unsigned char | Scalar | Pt_LEFT |
Pt_ARG_SEP_IMAGE_V_ALIGN | unsigned char | Scalar | Pt_TOP |
Pt_ARG_SEP_TYPE | unsigned short | Scalar | Pt_SINGLE_ LINE |
Pt_CB_SEP_DRAG | PtCallback_t * | Link | NULL |
C type | Pt type | Default |
---|---|---|
PhBitmapCursorDescription_t * | Alloc | NULL |
A pointer to a PhBitmapCursorDescription_t, which represents the cursor which is used when the separator is armed and being dragged.
You can't edit this resource in PhAB.
The widget automatically sets the hdr member of the PhBitmapCursorDescription_t and PhBitmapCursorData_t structures.
The PhBitmapCursorDescription_t contains at least these members:
The PhCharacterCursorDescription_t contains at least these members:
The PhBitmapCursorData_t contains at least these members:
C type | Pt type | Default |
---|---|---|
PgColor_t | Scalar | Ph_CURSOR_DEFAULT_COLOR |
A PgColor_t structure that defines the color for the cursor specified by the Pt_ARG_SEP_ARM_CURSOR_TYPE, which is used when the separator is armed and being dragged. For more information, see PgColor_t in the Photon Library Reference.
C type | Pt type | Default |
---|---|---|
unsigned short | Scalar | Ph_CURSOR_INHERIT |
The cursor type which is used when the separator is armed and being dragged. It can be:
C type | Pt type | Default |
---|---|---|
PhRect_t | Struct | NULL |
The dragging boundary for the separator. This resource is used when dragging is initiated (see the Pt_SEP_DRAGGABLE flag). The default of this resource is the widget's parent's canvas. Set the resource to NULL to use the defaults.
C type | Pt type | Default |
---|---|---|
short | Flag | Pt_SEP_HORIZONTAL |
Flags that control the separator's appearance. Possible values:
C type | Pt type | Default |
---|---|---|
PhImage_t | Image | NULL |
You can use this resource to create your own style of separator. It specifies an image to be used as the separator. Set to NULL to disable image drawing. For more information about PhImage_t, see the Photon Library Reference.
C type | Pt type | Default |
---|---|---|
unsigned char | scalar | Pt_LEFT |
The separator's horizontal image alignment. Can be one of:
C type | Pt type | Default |
---|---|---|
unsigned char | scalar | Pt_TOP |
The separator's vertical image alignment. Can be one of:
C type | Pt type | Default |
---|---|---|
unsigned short | Scalar | Pt_SINGLE_LINE |
The type of separator. Possible values:
C type | Pt type | Default |
---|---|---|
PtCallback_t * | Link | NULL |
A list of PtCallback_t structures that define the callbacks involved when you drag the separator widget.
Each callback is passed a PtCallbackInfo_t structure that contains at least the following members:
If the widget modifies an inherited resource, the “Default override” column indicates the new value. This modification affects any subclasses of the widget.
Pt_ARG_BANDWIDTH_THRESHOLD defines the "graphics bandwidth" threshold over which the separator drag mode is switched to drag outline mode, as if the Pt_SEP_DRAW_DRAG_BAND flag was set. This optimizes the number of events in low bandwidth situations, such as when you are using phrelay. Note that this resource only applies when the separator is draggable.
By default this resource is set to Ph_BAUD_NETWORK.
For more information about the system bandwidth, see PtQuerySystemInfo() and PhSysInfo_t in the Photon Library Reference.