PtBitmap

A bitmap

Class hierarchy:

PtWidget --> PtBasic --> PtBitmap

For more information, see the diagram of the widget hierarchy.

PhAB icon:

Public header:

<photon/PtBitmap.h>

Description:

PtBitmap draws a bitmap. PtBitmap can be set, unset, or made unselectable. You can use it either in groups, button bars, menu bars, or as a single button.

Bitmapped images.

You must define a bitmap's dimensions via Pt_ARG_DIM before setting its Pt_ARG_BITMAP_DATA and Pt_ARG_SET_BITMAP_DATA resources. Once the bitmap's data has been specified, don't change the dimensions. You must set the Pt_ARG_SET_BITMAP_COLORS resource prior to setting Pt_ARG_SET_BITMAP_DATA.

New resources:

Pt_ARG_BITMAP_BALLOON

By default, when a user pauses the pointer over this widget, the widget will display a small yellow balloon. If you want to change the look or default text of the balloon, you can use this resource to override the default value supplied by the default inflate function.

Here's a prototype of a sample inflate function:

PtWidget_t *InflateBalloon( PtWidget_t *window,
                            PtWidget_t *widget,
                            int position,
                            char *text,
                            char *font,
                            PgColor_t fill_color,
                            PgColor_t text_color );
        

where:

window

The parent of the widget requiring the balloon.

widget

The widget a balloon will be displayed over.

position

The balloon's position (see Pt_ARG_BITMAP_BALLOON_POSITION below).

text

The text to display (see Pt_ARG_BITMAP_TEXT below).

font

The font for the text.

fill_color

The fill color (see Pt_ARG_BITMAP_BALLOON_FILL_COLOR below).

text_color

The balloon-text color (see Pt_ARG_BITMAP_BALLOON_COLOR below).

In your function, you can either use the supplied values, or ignore them and use values of your own.

Pt_ARG_BITMAP_BALLOON_COLOR

The balloon's text color.

Pt_ARG_BITMAP_BALLOON_FILL_COLOR

The balloon's fill color.

Pt_ARG_BITMAP_BALLOON_POSITION

Indicates where the bitmap text will pop up. Possible values:

• Pt_BITMAP_BALLOON_BOTTOM
• Pt_BITMAP_BALLOON_INPLACE
• Pt_BITMAP_BALLOON_LEFT
• Pt_BITMAP_BALLOON_RIGHT
• Pt_BITMAP_BALLOON_TOP

Pt_ARG_BITMAP_COLORS

An array of colors (1 for each bitplane). To set the number of bitplanes, use the len argument to the PtSetArg() macro.

You must set this resource prior to setting Pt_ARG_BITMAP_DATA.

Pt_ARG_BITMAP_DATA

The bitmap data. Each bit represents a single pixel and each horizontal line must be rounded up to a multiple of 8 bits. For more information, see PgDrawBitmap(). To control the dimensions of the bitmap, use Pt_ARG_AREA or Pt_ARG_DIM.

You must define a bitmap's dimensions via Pt_ARG_DIM before setting its Pt_ARG_BITMAP_DATA and Pt_ARG_SET_BITMAP_DATA resources. Once the bitmap's data has been specified, don't change the dimensions.

Pt_ARG_BITMAP_FLAGS

Possible values:

Pt_BITMAP_SHOW_BALLOON

If the pointer remains motionless for 1.25 seconds over the bitmap, pop up a balloon with the bitmap's text.

The default setting for this resource is 0; that is, no flags are set.

Pt_ARG_BITMAP_TEXT

The text string to display in the balloon.

Pt_ARG_BMP_SET_BG_COLOR

The background color that the widget uses when it becomes armed (that it, when it's pressed in). Pt_ARG_BMP_SET_BG_FILL must be set to Pt_TRUE for this resource to be used.

Pt_ARG_BMP_SET_BG_FILL

Indicates whether or not Pt_ARG_BMP_SET_BG_COLOR will be used when the widget becomes armed. Possible values:

Pt_TRUE

Use the value of Pt_ARG_BMP_SET_BG_COLOR.

Pt_FALSE

Ignore the value of Pt_ARG_BMP_SET_BG_COLOR, and use Pg_TRANSPARENT instead.

Pt_ARG_SET_BITMAP_COLORS

An array of colors (1 for each bitplane). To set the number of bitplanes, use the len argument to the PtSetArg() macro.

You must set this resource prior to setting Pt_ARG_SET_BITMAP_DATA.

Pt_ARG_SET_BITMAP_DATA

This resource defines the armed bitmap data. The format of the data is the same as in Pt_ARG_BITMAP_DATA (see above).

You must define a bitmap's dimensions via Pt_ARG_DIM before setting its Pt_ARG_BITMAP_DATA and Pt_ARG_SET_BITMAP_DATA resources. Once the bitmap's data has been specified, don't change the dimensions. You must set the Pt_ARG_SET_BITMAP_COLORS resource prior to setting Pt_ARG_SET_BITMAP_DATA.

Inherited resources:

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_DIM

You must define a bitmap's dimensions via Pt_ARG_DIM before setting its Pt_ARG_BITMAP_DATA and Pt_ARG_SET_BITMAP_DATA resources. Once the bitmap's data has been specified, don't change the dimensions.