<<

Contents

Search

>>

 

SET_SPLIT_WINDOW_HEADER

 

 

Function

 

 

Syntax:

SET_SPLIT_WINDOW_HEADER(<Split Handle>, <Text>, <Image Name>, <Font Name>, <Font Height>, <Font Style>, <Height of Header>, <Text Alignment>, <Image Alignment>, <Red-1>, <Green-1>, <Blue-1>, <Red-2>, <Green-2>, <Blue-2>, <Direction> [,<Macroname>])

 

<Split Handle>

= <NUM-EXPRESSION>

<Text>

= <STRING-EXPRESSION>

<Image Name>

= <STRING-EXPRESSION>

<Font Name>

= <STRING-EXPRESSION>

<Font Height>

= <NUM-EXPRESSION>

<Font Style>

= <NUM-EXPRESSION>

<Height of Header>

= <NUM-EXPRESSION>

<Text Alignment>

= <NUM-EXPRESSION>

<Image Alignment>

= <NUM-EXPRESSION>

<Red-1>

= <NUM-EXPRESSION>

<Green-1>

= <NUM-EXPRESSION>

<Blue-1>

= <NUM-EXPRESSION>

<Red-2>

= <NUM-EXPRESSION>

<Green-2>

= <NUM-EXPRESSION>

<Blue-2>

= <NUM-EXPRESSION>

<Direction>

= <NUM-EXPRESSION>

<Macroname>

= <MACRONAME>

 

 

Meaning:

Creates a header line in a split window.

 

In the header line a text or/and an image (button for closing the split window) can be displayed.

 

The position of <Text> and <Image Name> is specified by the parameters <Text Alignment> and <Image Alignment>.

 

<Image Alignment>

Alignment

> 0

The image is right-aligned. The text is always on the left side of the image.

< 0

The image is left-aligned. The text is always on the right side of the image.

= 0

The image is centered. <Text Alignment> defines whether the text is shown on the left or right side of the image.

 

<Text Alignment>

Alignment

> 0

The text is right-aligned.

< 0

The text is left-aligned.

= 0

The text is centered.

 

The colors <Red-1>, <Green-1>, <Blue-1>, <Red-2>, <Green-2> and <Blue-2> define the background color gradient of the header line. If one of the colors <Red-2>, <Green-2> or <Blue-2> <= 0, the background color of the header line is specified by <Red-1>, <Green-1> and <Blue-1>.

 

The instructions SPLIT_HEADER_BACKGROUNDCOLOR, SPLIT_HEADER_BACKGROUNDGRADIENT, SPLIT_HEADER_FONT, SPLIT_HEADER_FONTNAME and SPLIT_HEADER_FONTHEIGHT have no effect with this function.

 

The instruction SPLIT_HEADER_TEXTCOLOR specifies the textcolor of  <Text>.

 

SET_SPLIT_WINDOW_HEADER returns the following values:

 

0: The function has been executed successfully.

-1: The split window <Split-Handle> does not exist.

 

Parameter:

Split Handle

Handle of split window

 

Text

Text to be displayed in the header line.

 

Image Name

Specifies the image to be displayed. If the displayed image is clicked with the mouse, the Macro <Macroname> is executed. If no <Macroname> has been specified, the split window is closed when the image is clicked, like with the function REMOVE_SPLIT_WINDOW.

 

Font Name

Font for display of <Text>

 

Font Height

Font height in point for display of <Text>

 

Font Style

Font type for display of <Text>:

0: normal

1: bold

2: italic

3. bold + italic

otherwise: normal

 

Height of Header

The height of the header line is calculated from the image size and the font size. If <Height of Header> is smaller than the calculated height, the parameter does not have any effect. If <Height of Header> is bigger than the calculated height, the header line is enlarged appropriately. <Height of Header> must be defined in pixel.

 

Text Alignment

Alignment of the text

 

Image Alignment

Alignment of the image

 

Red-1

Color-1: Red value

 

Green-1

Color-1: Green value

 

Blue-1

Color-1: Blue value

 

Red-2

Color-2: Red value

 

Green-2

Color-2: Green value

 

Blue-2

Color-2: Blue value

 

Direction

Defines the direction of the color gradient:

1 = from left to right

2 = from top to bottom

3 = from top right to bottom left

4 = from center outwards

5 = from left to center right

6 = from top to bottom center

otherwise = from top left to bottom right

 

Macroname

Name of the Macro that is executed if the image is clicked.

 

Sample:

HANDLE% = SPLIT_WINDOW(0,1,60,-1,-1,-1)

IF HANDLE% < 0

THEN ... Error ...

ENDIF

 

/* Create header line: text left, image right, grey background

 

H% = SET_SPLIT_WINDOW_HEADER(SPLIT_NR,"Info","ebusclose.gif",

               "Arial",20,0,0,-1,1,192,192,192,-1,-1,-1,0)

IF H% <> 0

THEN ... Error ...

ENDIF

 

 

See also:

REMOVE_SPLIT_WINDOW_HEADER

SPLIT_WINDOW

REMOVE_SPLIT_WINDOW

SPLIT_HEADER_TEXTCOLOR

SPLIT_HEADER_BACKGROUNDCOLOR

SPLIT_HEADER_BACKGROUNDGRADIENT

SPLIT_HEADER_FONT

SPLIT_HEADER_FONTNAME

SPLIT_HEADER_FONTHEIGHT

SPLIT_HEADER_IMAGE_MARGIN