Unit 'Intuition' Package
[Overview][Constants][Types][Procedures and functions][Variables][Index] [#aros]

SetWindowTitles

Set the window's titles for both window and screen.

Declaration

Source position: intuition.pas line 3233

procedure SetWindowTitles(

  Window: PWindow;

  const WindowTitle: PChar;

  const ScreenTitle: PChar

);

Arguments

Window

  

A pointer to your window structure

WindowTitle

  

A pointer to a null-terminated text string, or set to either the value of -1 (negative one) or 0 (zero). If you specify a string, this string is not copied.

ScreenTitle

  

A pointer to a null-terminated text string, or set to either the value of -1 (negative one) or 0 (zero). If you specify a title for the screen, this title will be shown when the window becomes active. If you specify a string, this string is not copied.

Description

Allows you to set the text which appears in the Window and/or Screen title bars.

The window title appears at all times along the window title bar. The window's screen title appears at the screen title bar whenever this window is the active one.

When this routine is called, your window title will be changed immediately. If your window is the active one when this routine is called, the screen title will be changed immediately.

You can specify a value of -1 (i.e. PByte($FF)) for either of the title pointers. This designates that you want Intuition to leave the current setting of that particular title alone, and modify only the other one. Of course, you could set both to -1.

Furthermore, you can set a value of nil for either of the title pointers. Doing so specifies that you want no title to appear (the title bar will be blank).

Both of the titles are rendered in the default font of the window's screen, as set using OpenScreen().

In setting the window's title, Intuition may do some other rendering in the top border of your window. If your own rendering sometimes appears in your window border areas, you may want to restore the entire window border frame. The function SetWindowTitles() does not do this in the newer versions. The function RefreshWindowFrame() is provided to do this kind of thing for you.

Note:You should be careful with specifying a screen title because that may irritate the user.

See also

OpenWindow

  

Open an Intuition window.

RefreshWindowFrame

  

Ask Intuition to redraw your window border.

OpenScreen

  

Open an Intuition screen


Documentation generated on: 2021-07-30