This page lists all existing component properties. Some properties apply to all components, such as CP_RelativeX, and some apply only to one or a few components. This page briefly describes each property.
CP_AdjustmentType
CP_AdjustmentVal
CP_BgColor
CP_Bitmap
CP_BitmapRect (v1.02)
CP_BitmapX
CP_BitmapY
CP_BlinkDelay
CP_BorderX
CP_BorderY
CP_CallbackArg1
CP_CallbackArg2
CP_Caret
CP_ChannelLength
CP_ComponentSpacing
CP_Cursor (v1.02)
CP_FgColor
CP_Font
CP_FontPaletteIndex (v1.02)
CP_HandlePosition
CP_Height
CP_HorizontalAlign
CP_LayoutDirection
CP_Movie
CP_PaletteIndex
CP_RelativeX
CP_RelativeY
CP_Render
CP_Text
CP_TiledBitmap
CP_VerticalAlign
CP_Width
CP_X
CP_Y
CP_ZOrder
Type: int
A type of pixel-adjustment layer used in CK_AdjustmentLayer components. Currently implemented adjustment types are:
- ADJUST_LIGHTEN - Used to increase the intensity (or brightness) of a component.
- ADJUST_DARKEN - Used to decrease the intensity of a component.
Used by: CK_AdjustmentLayer
Type: int
An adjustment value whose meaning depends on the particular adjustment type. Currently we have:
- ADJUST_LIGHTEN - Value represents the percentage lightened.
- ADJUST_DARKEN - Value represents the percentage darkened.
Used by: CK_AdjustmentLayer
Type: RGBQUAD *
The background color for a component. If no background color is set, the component will have no background (unless an alternate bitmap background is set using CP_Bitmap).
Used by: CK_Label, CK_BBoard, CK_RowColumn, CK_Frame, CK_ClipWindow
Type: CK_Bitmap *
Usually represents a bitmap to be used as the component's background. For scroll handles, it represents the bitmap used for the scroll handle. All components observe their bitmap properties. If the bitmap is deleted, the component will remove its internal reference to the bitmap.
Used by: CK_Label, CK_BBoard, CK_RowColumn, CK_Frame, CK_ClipWindow, CK_ScrollHandle
Type: CK_Rect *
Specifies the portion of the bitmap (CP_Bitmap) to be displayed. This property allows components to display just a portion of a bitmap.
Used by: CK_Label, CK_BBoard, CK_RowColumn, CK_Frame, CK_ClipWindow, CK_ScaledLabel, CK_ScrollHandle
Type: int
This is the X offset from the left edge of the component from which to draw the bitmap (CP_Bitmap). The offset can be positive or negative.
Used by: CK_BBoard, CK_RowColumn, CK_Frame, CK_ClipWindow
Type: int
This is the Y offset from the top edge of the component from which to draw the bitmap (CP_Bitmap). The offset can be positive or negative.
Used by: CK_BBoard, CK_RowColumn, CK_Frame, CK_ClipWindow
Type: int
The number of milliseconds between blinks for the blinking caret in a line edit component.
Used by: CK_LineEdit
Type: int
The border width on the left and right sides of the component. For labels, the Chilkat engine will clip to within the border before drawing text. In all cases, the bitmap or background color will be drawn before the engine clips to within the borders. For example, with a CK_Frame, the engine draws the background bitmap, if any, then clips to within the border, and then draws the frame's child.
Used by: CK_Label, CK_BBoard, CK_RowColumn, CK_Frame
Type: int
The border height on the top and bottom of the component. See CP_BorderX for a more detailed explanation.
Used by: CK_Label, CK_BBoard, CK_RowColumn, CK_Frame
Type: int
The value to be passed in 'arg1' of a CK_Screen's componentCB() function.
Used by: All components
Type: int
The value to be passed in 'arg1' of a CK_Screen's componentCB() function.
Used by: All components
Type: CK_Bitmap *
The bitmap to be used as the blinking caret in a line edit component. The line edit component will use the underscore character of the component's font if no caret is supplied.
Used by: CK_LineEdit
Type: int
The logical length of the channel in which the scroll handle slides. The logical length can be any number greater than zero. When the scroll handle is at the top (left) of the channel, it is at logical position 0. When the scroll handle is at the bottom (right), it is at logical position CP_ChannelLength-1.
Used by: CK_ScrollHandle
Type: int
The number of pixels separating each child component of a row-column.
Used by: CK_RowColumn
Type: RGBCOLOR *
The foreground color of the text used in a label or line edit. This only applies if the label's font is a CK_WindowsFont.
Used by: CK_Label, CK_LineEdit
Type: CK_Font *
The font used to draw the text in a label or line edit.
Used by: CK_Label, CK_LineEdit
Type: int
If the font was created with an 8-bit bitmap with multiple palettes, this selects the palette to be displayed when the font is drawn.
Used by: CK_Label, CK_LineEdit
Type: int
The current logical scroll handle position. Setting this property will cause the scroll handle to move to that position.
Used by: CK_ScrollHandle
Type: int
The height in pixels of the component.
Used by: All components
Type: int
The horizontal alignment of text, or components in a row-column. Aligment can be left justified, right justified, or centered. (CV_HorizAlignLeft, CV_HorizAlignRight, CV_HorizAlignCenter)
Used by: CK_Label, CK_LineEdit, CK_RowColumn
Type: int
Vertical or horizontal. (CV_LayoutHorizontal or CK_LayoutVertical)
Used by: CK_RowColumn, CK_ScrollHandle
Type: CK_Movie *
This is an AVI or MPEG movie. Currently, only CK_Labels can display movies.
Used by: CK_Label
Type: int
Chooses the palette in the palette set to be drawn with the bitmap. Only applies if the component has a bitmap, and if the bitmap is 8 bits per pixel.
Used by: CK_Label, CK_BBoard, CK_LineEdit, CK_RowColumn, CK_Frame, CK_ClipWindow, CK_ScrollHandle
Type: int
The relative X-position of the component when the component is a child of a bulletin board. The position is relative to the left edge of the bulletin board, and can be negative.
Used by: All components
Type: int
The relative Y-position of the component when the component is a child of a bulletin board. The position is relative to the top edge of the bulletin board, and can be negative.
Used by: All components
Type: CK_Render *
A callback object called by a viewport component to render the contents of the viewport. The user must create a class derived from CK_Render, and implement the render() function.
Used by: CK_Viewport
Type: const char *
The text displayed in a label or line edit.
Used by: CK_Label, CK_LineEdit
Type: int
If TRUE, then the bitmap is drawn tiled to fill the component's area.
Used by: CK_BBoard, CK_RowColumn, CK_Frame, CK_ClipWindow
Type: int
The vertical alignment of text, or components in a row-column. Aligment can be top-aligned, bottom-aligned, or centered. (CV_VertAlignTop, CV_VertAlignBottom, CV_VertAlignCenter)
Used by: CK_Label, CK_LineEdit, CK_RowColumn
Type: int
The width in pixels of the component.
Used by: All components
Type: int
The X position in screen coordinates of the component. This property should never be explicitly set by the user.
Used by: All components
Type: int
The Y position in screen coordinates of the component. This property should never be explicitly set by the user.
Used by: All components
Type: int
The Z-order of the component. This is used by bulletin board components when determining the order to draw child components.
Used by: All components
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |