4D Plugin API


PA_SetWindowFocused (windowRef)

Parameter Type Description
windowRef PA_WindowRef Window reference

Description

The routine PA_SetWindowFocused prepares the window windowRef to be focused (by the user or by the plug-in)

Only focusable windows can receive the keyboard focus. A focusable window is a window that can receive keyboard events ("get the focus"), even if it is a floating window. When a focusable window receives a keyboard event, it becomes focused. For example, the tool palette of the Form Editor is not focusable. When the user clicks on it, it does not get the focus, which remains in the Editor. On the other hand, the properties palette is focusable. When the user clicks in an editable field (to set a variable name, an object name) of this palette, it takes the focus and the keyboard events.

Example

Force window aWindow to get the focus.

   // Be sure the window is focusable. If not, make it focusable
   if(!PA_IsFocusable(aWindow))
      PA_SetFocusable(aWindow);
   // Give it the focus now
   PA_SetWindowFocused(aWindow);

See Also

PA_GetWindowFocused , PA_IsWindowFocusable , PA_IsWindowFocused , PA_SetWindowFocusable .

Error Handling

PA_GetLastError

always returns eER_NoErr