Popstring.mui Class Reference

BOOPSI custom class Popstring.mui (MUI 3.8 dev). Each ### sub-section below documents one of the class's attributes or methods. Sub-classes of Popstring.mui are listed at the end under Sub-classes; the class hierarchy itself is documented in the MUI classes index.

Function index

Class definition

Attributes

Methods

Popstring.mui

MUIA_Popstring_Button

**MUIA_Popstring_Button -- (V7 ) [I.G], Object ***

Function

Specify the button object to be used in the popup. Depending on the type of your popup, you should use an image button with MUII_PopUp, MUII_PopFile or MUII_PopDrawer here. However, its also possible to have a button with some text or other things in it. When the popstring object is disposed, the string and the button objects are disposed as well.

Example

pop = PopstringObject,
MUIA_Popstring_String, KeyString(0,60,'n'),
MUIA_Popstring_Button, PopButton(MUII_PopUp),
MUIA_Popstring_OpenHook, &OpenHook,
MUIA_Popstring_CloseHook, &CloseHook,
End;

See also

MUIA_Popstring_String, MUIA_Popstring_OpenHook, MUIA_Popstring_CloseHook

MUIA_Popstring_CloseHook

**MUIA_Popstring_CloseHook -- (V7 ) [ISG], struct Hook ***

Function

Whenever the popup receives a MUIM_Popstring_Close method and the popup is currently opened, this hook will be called. It will receive a pointer to itself in register A0, a pointer to the complete popup object in A2 and a pointer to a struct { Object *stringobject; LONG success; }, in A1. The success parameter is a copy of the methods success parameter and indicates whether the popup was closed successfully (e.g. with a double click in a listview) or was just cancelled (e.g. by pressing the popup button again for toggle popups). Due to internal message handling issues, calling the close hook is delayed until the next MUIM_HandleInput method is called. This allows you to remove and dispose windows without danger.

See also

MUIA_Popstring_OpenHook, MUIM_Popstring_Open, MUIM_Popstring_Close

MUIA_Popstring_OpenHook

**MUIA_Popstring_OpenHook -- (V7 ) [ISG], struct Hook ***

Function

Whenever the popup receives a MUIM_Popstring_Open method, this hook will be called. It will receive a pointer to itself in register A0, a pointer to the complete popup object in A2 and a pointer to a pointer (!) to the string object contained in the popup object in A1. When this hook returns TRUE, MUI assumes the popup was opened succesfully and will disabled the popup button (as long as MUIA_Popstring_Toggle is not set). Return FALSE to indicate that something went wrong and the popup could not be opened.

See also

MUIA_Popstring_CloseHook, MUIM_Popstring_Open, MUIM_Popstring_Close

MUIA_Popstring_String

**MUIA_Popstring_String -- (V7 ) [I.G], Object ***

Function

Specify the string object to be used in the popup. This does not necessarily need to be a real string object, using text objects or even complete groups of other objects is perfectly ok. When the popstring object is disposed, the string and the button objects are disposed as well.

Example

pop = PopstringObject,
MUIA_Popstring_String, KeyString(0,60,'n'),
MUIA_Popstring_Button, PopButton(MUII_PopUp),
MUIA_Popstring_OpenHook, &OpenHook,
MUIA_Popstring_CloseHook, &CloseHook,
End;

See also

MUIA_Popstring_Button, MUIA_Popstring_OpenHook, MUIA_Popstring_CloseHook

MUIA_Popstring_Toggle

MUIA_Popstring_Toggle -- (V7 ) [ISG], BOOL

Function

Set/Clear the toggle mode for a popstring object. With toggling disabled, the popup button will get disabled whenever the user hits it and the popup opens. With toggling enabled, the popup button always stays enabled and can be used to cancel (== close with a FALSE return value) the popup.

See also

MUIA_Popstring_OpenHook

MUIM_Popstring_Close

MUIM_Popstring_Close (V7 ) — SYNOPSIS — DoMethod(obj,MUIM_Popstring_Close,LONG result);

Function

This method closes the popup. In fact, it only calls the predefined MUIA_Popstring_CloseHook with the supplied success parameter.

Example

DoMethod(poplist,MUIM_Notify,MUIA_Listview_DoubleClick,TRUE,
popobj,2,MUIM_Popstring_Close,TRUE);

MUIM_Popstring_Open

MUIM_Popstring_Open (V7 ) — SYNOPSIS — DoMethod(obj,MUIM_Popstring_Open);

Function

This method opens the popup. In fact, it only calls the predefined MUIA_Popstring_OpenHook and checks its return value. In case of TRUE, the popup button object is disabled as long as MUIA_Popstring_Toggle is unset. If the toggle mode is enabled, using MUIA_Popstring_Open on a currently opened popup will result in closing this popup (i.e. calling the close hook) with a success value of FALSE.

Example

DoMethod(popbutton,MUIM_Notify,MUIA_Pressed,FALSE,
popobj,1,MUIM_Popstring_Open);