/*******************************************************************************
* Copyright (c) 2000, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.swt.widgets;
import org.eclipse.swt.internal.*;
import org.eclipse.swt.internal.photon.*;
import org.eclipse.swt.*;
import org.eclipse.swt.graphics.*;
import org.eclipse.swt.events.*;
/**
* Instances of this class represent the "windows"
* which the desktop or "window manager" is managing.
* Instances that do not have a parent (that is, they
* are built using the constructor, which takes a
* Display
as the argument) are described
* as top level shells. Instances that do have
* a parent are described as secondary or
* dialog shells.
*
* Instances are always displayed in one of the maximized, * minimized or normal states: *
RESIZE
) until it is
* no longer maximized.
*
* The modality of an instance may be specified using
* style bits. The modality style bits are used to determine
* whether input is blocked for other shells on the display.
* The PRIMARY_MODAL
style allows an instance to block
* input to its parent. The APPLICATION_MODAL
style
* allows an instance to block input to every other shell in the
* display. The SYSTEM_MODAL
style allows an instance
* to block input to all shells, including shells belonging to
* different applications.
*
* Note: The styles supported by this class are treated
* as HINTs, since the window manager for the
* desktop on which the instance is visible has ultimate
* control over the appearance and behavior of decorations
* and modality. For example, some window managers only
* support resizable windows and will always assume the
* RESIZE style, even if it is not set. In addition, if a
* modality style is not supported, it is "upgraded" to a
* more restrictive modality style that is supported. For
* example, if PRIMARY_MODAL
is not supported,
* it would be upgraded to APPLICATION_MODAL
.
* A modality style may also be "downgraded" to a less
* restrictive style. For example, most operating systems
* no longer support SYSTEM_MODAL
because
* it can freeze up the desktop, so this is typically
* downgraded to APPLICATION_MODAL
.
*
SWT
provides two "convenience constants"
* for the most commonly required style combinations:
* SHELL_TRIM
CLOSE | TITLE | MIN | MAX | RESIZE
)
* DIALOG_TRIM
TITLE | CLOSE | BORDER
)
* * Note: Only one of the styles APPLICATION_MODAL, MODELESS, * PRIMARY_MODAL and SYSTEM_MODAL may be specified. *
* IMPORTANT: This class is not intended to be subclassed. *
* * @see Decorations * @see SWT * @see Shell snippets * @see SWT Example: ControlExample * @see Sample code and further information * @noextend This class is not intended to be subclassed by clients. */ public class Shell extends Decorations { int shellHandle; Menu activeMenu; int blockedList; Control lastActive; boolean modified; /** * Constructs a new instance of this class. This is equivalent * to callingShell((Display) null)
.
*
* @exception SWTException Shell((Display) null, style)
.
*
* The style value is either one of the style constants defined in
* class SWT
which is applicable to instances of this
* class, or must be built by bitwise OR'ing together
* (that is, using the int
"|" operator) two or more
* of those SWT
style constants. The class description
* lists the style constants that are applicable to the class.
* Style bits are also inherited from superclasses.
*
SWT.SHELL_TRIM
.
* * Note: Currently, null can be passed in for the display argument. * This has the effect of creating the shell on the currently active * display if there is one. If there is no current display, the * shell is created on a "default" display. Passing in null as * the display argument is not considered to be good coding style, * and may not be supported in a future release of SWT. *
* * @param display the display to create the shell on * * @exception SWTException
* The style value is either one of the style constants defined in
* class SWT
which is applicable to instances of this
* class, or must be built by bitwise OR'ing together
* (that is, using the int
"|" operator) two or more
* of those SWT
style constants. The class description
* lists the style constants that are applicable to the class.
* Style bits are also inherited from superclasses.
*
* Note: Currently, null can be passed in for the display argument. * This has the effect of creating the shell on the currently active * display if there is one. If there is no current display, the * shell is created on a "default" display. Passing in null as * the display argument is not considered to be good coding style, * and may not be supported in a future release of SWT. *
* * @param display the display to create the shell on * @param style the style of control to construct * * @exception SWTExceptionSWT.DIALOG_TRIM
.
* * Note: Currently, null can be passed in for the parent. * This has the effect of creating the shell on the currently active * display if there is one. If there is no current display, the * shell is created on a "default" display. Passing in null as * the parent is not considered to be good coding style, * and may not be supported in a future release of SWT. *
* * @param parent a shell which will be the parent of the new instance * * @exception IllegalArgumentException
* The style value is either one of the style constants defined in
* class SWT
which is applicable to instances of this
* class, or must be built by bitwise OR'ing together
* (that is, using the int
"|" operator) two or more
* of those SWT
style constants. The class description
* lists the style constants that are applicable to the class.
* Style bits are also inherited from superclasses.
*
* Note: Currently, null can be passed in for the parent. * This has the effect of creating the shell on the currently active * display if there is one. If there is no current display, the * shell is created on a "default" display. Passing in null as * the parent is not considered to be good coding style, * and may not be supported in a future release of SWT. *
* * @param parent a shell which will be the parent of the new instance * @param style the style of control to construct * * @exception IllegalArgumentExceptionShellListener
interface.
*
* @param listener the listener which should be notified
*
* @exception IllegalArgumentException true
if the receiver is currently
* in fullscreen state, and false otherwise.
* * * @return the fullscreen state * * @exception SWTException
SWT
:
* NONE
, ROMAN
, DBCS
,
* PHONETIC
, NATIVE
, ALPHA
.
*
* @return the IME mode
*
* @exception SWTException true
if the receiver is marked as modified, or false
otherwise
*
* @exception SWTException null
if the shell has the default shape.
*
* @return the region that defines the shape of the shell, or null
*
* @exception SWTException * @return the dialog shells * * @exception SWTException
*
* @return a ToolBar object representing the Shell's tool bar, or
* This operation requires the operating system's advanced
* widgets subsystem which may not be available on some
* platforms.
*
* Note: The result of intermixing calls to
*
*
* @since 3.7
*/
public ToolBar getToolBar() {
return null;
}
void hookEvents () {
super.hookEvents ();
int windowProc = display.windowProc;
OS.PtAddCallback (shellHandle, OS.Pt_CB_WINDOW, windowProc, OS.Pt_CB_WINDOW);
OS.PtAddCallback (shellHandle, OS.Pt_CB_RESIZE, windowProc, OS.Pt_CB_RESIZE);
}
int hotkeyProc (int w, int data, int info) {
if (data != 0) {
Widget widget = WidgetTable.get (data);
if (widget instanceof MenuItem) {
MenuItem item = (MenuItem) widget;
if (item.isEnabled ()) item.Pt_CB_ACTIVATE (data, info);
}
}
return OS.Pt_CONTINUE;
}
/**
* Moves the receiver to the top of the drawing order for
* the display on which it was created (so that all other
* shells on that display, which are not the receiver's
* children will be drawn behind it), marks it visible,
* sets the focus and asks the window manager to make the
* shell active.
*
* @exception SWTException
*
*
* @see Control#moveAbove
* @see Control#setFocus
* @see Control#setVisible
* @see Display#getActiveShell
* @see Decorations#setDefaultButton(Button)
* @see Shell#setActive
* @see Shell#forceActive
*/
public void open () {
checkWidget();
setVisible (true);
if (isDisposed ()) return;
traverseGroup (true);
}
public boolean print (GC gc) {
checkWidget ();
if (gc == null) error (SWT.ERROR_NULL_ARGUMENT);
if (gc.isDisposed ()) error (SWT.ERROR_INVALID_ARGUMENT);
return false;
}
int Pt_CB_RESIZE (int widget, int info) {
if (info == 0) return OS.Pt_CONTINUE;
PtCallbackInfo_t cbinfo = new PtCallbackInfo_t ();
OS.memmove (cbinfo, info, PtCallbackInfo_t.sizeof);
if (cbinfo.cbdata == 0) return OS.Pt_CONTINUE;
int [] args = {OS.Pt_ARG_WIDTH, 0, 0, OS.Pt_ARG_HEIGHT, 0, 0};
OS.PtGetResources (shellHandle, args.length / 3, args);
resizeBounds (args [1], args [4]);
sendEvent(SWT.Resize);
if (layout != null) {
markLayout (false, false);
updateLayout (false);
}
return OS.Pt_CONTINUE;
}
int Pt_CB_WINDOW (int widget, int info) {
if (info == 0) return OS.Pt_CONTINUE;
PtCallbackInfo_t cbinfo = new PtCallbackInfo_t ();
OS.memmove (cbinfo, info, PtCallbackInfo_t.sizeof);
if (cbinfo.cbdata == 0) return OS.Pt_CONTINUE;
PhWindowEvent_t we = new PhWindowEvent_t ();
OS.memmove (we, cbinfo.cbdata, PhWindowEvent_t.sizeof);
switch (we.event_f) {
case OS.Ph_WM_CLOSE:
closeWidget ();
break;
case OS.Ph_WM_ICON:
if ((we.state_f & OS.Ph_WM_STATE_ISICONIFIED) != 0) {
sendEvent (SWT.Iconify);
} else {
sendEvent (SWT.Deiconify);
}
break;
case OS.Ph_WM_FOCUS:
switch ((int) we.event_state) {
case OS.Ph_WM_EVSTATE_FOCUS: sendEvent (SWT.Activate); break;
case OS.Ph_WM_EVSTATE_FOCUSLOST: sendEvent (SWT.Deactivate); break;
}
break;
case OS.Ph_WM_MOVE:
sendEvent (SWT.Move);
break;
}
return OS.Pt_CONTINUE;
}
void register () {
super.register ();
WidgetTable.put (shellHandle, this);
}
void realizeWidget() {
/* Do nothing */
}
void releaseParent () {
/* Do nothing */
}
void releaseHandle () {
super.releaseHandle ();
shellHandle = 0;
}
void releaseChildren (boolean destroy) {
Shell [] shells = getShells ();
for (int i=0; i
*
*
* @see ShellListener
* @see #addShellListener
*/
public void removeShellListener (ShellListener listener) {
checkWidget();
if (listener == null) error (SWT.ERROR_NULL_ARGUMENT);
if (eventTable == null) return;
eventTable.unhook (SWT.Close, listener);
eventTable.unhook (SWT.Iconify,listener);
eventTable.unhook (SWT.Deiconify,listener);
eventTable.unhook (SWT.Activate, listener);
eventTable.unhook (SWT.Deactivate, listener);
}
void reskinChildren (int flags) {
Shell [] shells = getShells ();
for (int i=0; i
*
*
* @since 3.4
*/
public void setAlpha (int alpha) {
checkWidget ();
/*Not implemented */
}
int setBounds (int x, int y, int width, int height, boolean move, boolean resize, boolean events) {
checkWidget();
if (OS.PtWidgetClass (shellHandle) != OS.PtWindow ()) {
int result = super.setBounds (x, y, width, height, move, resize, events);
if ((result & RESIZED) != 0) resizeBounds (width, height);
return result;
}
boolean isFocus = caret != null && caret.isFocusCaret ();
if (isFocus) caret.killFocus ();
if (resize) {
/* Get the trimings */
int [] args = {OS.Pt_ARG_WINDOW_RENDER_FLAGS, 0, 0};
OS.PtGetResources (shellHandle, args.length / 3, args);
int flags = args [1];
int [] left = new int [1], top = new int [1];
int [] right = new int [1], bottom = new int [1];
OS.PtFrameSize (flags, 0, left, top, right, bottom);
width = Math.max (width - left [0] - right [0], 0);
height = Math.max (height - top [0] - bottom [0], 0);
}
PhArea_t oldArea = new PhArea_t ();
OS.PtWidgetArea (shellHandle, oldArea);
if (move && resize) {
PhArea_t area = new PhArea_t ();
area.pos_x = (short) x;
area.pos_y = (short) y;
area.size_w = (short) width;
area.size_h = (short) height;
int ptr = OS.malloc (PhArea_t.sizeof);
OS.memmove (ptr, area, PhArea_t.sizeof);
OS.PtSetResource (shellHandle, OS.Pt_ARG_AREA, ptr, 0);
OS.free (ptr);
} else {
if (move) {
PhPoint_t pt = new PhPoint_t ();
pt.x = (short) x;
pt.y = (short) y;
int ptr = OS.malloc (PhPoint_t.sizeof);
OS.memmove (ptr, pt, PhPoint_t.sizeof);
OS.PtSetResource (shellHandle, OS.Pt_ARG_POS, ptr, 0);
OS.free (ptr);
} else if (resize) {
int [] args = {
OS.Pt_ARG_WIDTH, width, 0,
OS.Pt_ARG_HEIGHT, height, 0,
};
OS.PtSetResources (shellHandle, args.length / 3, args);
}
}
/*
* Feature in Photon. The shell does not issue WM_SIZE
* event notificatoin until it is realized. The fix is
* to detect size changes and send the events.
*/
if (!OS.PtWidgetIsRealized (shellHandle)) {
PhArea_t newArea = new PhArea_t ();
OS.PtWidgetArea (shellHandle, newArea);
boolean sameOrigin = oldArea.pos_x == newArea.pos_x && oldArea.pos_y == newArea.pos_y;
boolean sameExtent = oldArea.size_w == newArea.size_w && oldArea.size_h == newArea.size_h;
if (!sameOrigin & move) sendEvent (SWT.Move);
if (!sameExtent & resize) {
resizeBounds (newArea.size_w, newArea.size_h);
sendEvent(SWT.Resize);
if (layout != null) {
markLayout (false, false);
updateLayout (false);
}
}
}
if (isFocus) caret.setFocus ();
/* Always return 0 */
return 0;
}
/**
* Sets the full screen state of the receiver.
* If the argument is true
causes the receiver
* to switch to the full screen state, and if the argument is
* false
and the receiver was previously switched
* into full screen state, causes the receiver to switch back
* to either the maximized or normal states.
* setFullScreen(true)
,
* setMaximized(true)
and setMinimized(true)
will
* vary by platform. Typically, the behavior will match the platform user's
* expectations, but not always. This should be avoided if possible.
*
*
*
* @since 3.4
*/
public void setFullScreen (boolean fullScreen) {
checkWidget();
}
/**
* Sets the input method editor mode to the argument which
* should be the result of bitwise OR'ing together one or more
* of the following constants defined in class SWT
:
* NONE
, ROMAN
, DBCS
,
* PHONETIC
, NATIVE
, ALPHA
.
*
* @param mode the new IME mode
*
* @exception SWTException
*
*
* @see SWT
*/
public void setImeInputMode (int mode) {
checkWidget();
}
public void setMaximized (boolean maximized) {
checkWidget();
int bits = 0;
if (maximized) bits = OS.Ph_WM_STATE_ISMAX;
OS.PtSetResource (shellHandle, OS.Pt_ARG_WINDOW_STATE, bits, OS.Ph_WM_STATE_ISMAX);
if (OS.PtWidgetIsRealized (shellHandle)) {
PhWindowEvent_t event = new PhWindowEvent_t ();
event.rid = OS.PtWidgetRid (shellHandle);
event.event_f = maximized ? OS.Ph_WM_MAX : OS.Ph_WM_RESTORE;
OS.PtForwardWindowEvent (event);
}
}
public void setMenuBar (Menu menu) {
checkWidget();
if (menuBar == menu) return;
if (menu != null) {
if ((menu.style & SWT.BAR) == 0) error (SWT.ERROR_MENU_NOT_BAR);
if (menu.parent != this) error (SWT.ERROR_INVALID_PARENT);
}
if (menuBar != null) {
int menuHandle = menuBar.handle;
OS.PtSetResource (menuHandle, OS.Pt_ARG_FLAGS, OS.Pt_DELAY_REALIZE, OS.Pt_DELAY_REALIZE);
OS.PtUnrealizeWidget (menuBar.handle);
}
menuBar = menu;
int [] args = {OS.Pt_ARG_WIDTH, 0, 0, OS.Pt_ARG_HEIGHT, 0, 0};
OS.PtGetResources (shellHandle, args.length / 3, args);
int width = args [1], height = args [4];
if (menuBar != null) {
int menuHandle = menu.handle;
args = new int [] {
OS.Pt_ARG_WIDTH, width, 0,
OS.Pt_ARG_FLAGS, 0, OS.Pt_DELAY_REALIZE,
};
OS.PtSetResources (menuHandle, args.length / 3, args);
OS.PtRealizeWidget (menuHandle);
}
resizeBounds (width, height);
}
public void setMinimized (boolean minimized) {
checkWidget();
int bits = 0;
if (minimized) bits = OS.Ph_WM_STATE_ISICONIFIED;
OS.PtSetResource (shellHandle, OS.Pt_ARG_WINDOW_STATE, bits, OS.Ph_WM_STATE_ISICONIFIED);
if (OS.PtWidgetIsRealized (shellHandle)) {
PhWindowEvent_t event = new PhWindowEvent_t ();
event.rid = OS.PtWidgetRid (shellHandle);
event.event_f = OS.Ph_WM_HIDE;
event.event_state = (short) (minimized ? OS.Ph_WM_EVSTATE_HIDE : OS.Ph_WM_EVSTATE_UNHIDE);
OS.PtForwardWindowEvent (event);
}
}
/**
* Sets the receiver's modified state as specified by the argument.
*
* @param modified the new modified state for the receiver
*
*
* @exception SWTException
*
*
* @since 3.5
*/
public void setModified (boolean modified) {
checkWidget ();
this.modified = modified;
}
/**
* Sets the shape of the shell to the region specified
* by the argument. When the argument is null, the
* default shape of the shell is restored. The shell
* must be created with the style SWT.NO_TRIM in order
* to specify a region.
*
* @param region the region that defines the shape of the shell (or null)
*
* @exception IllegalArgumentException
*
* @exception SWTException
*
*
* @since 3.0
*
*/
public void setRegion (Region region) {
checkWidget ();
if ((style & SWT.NO_TRIM) == 0) return;
super.setRegion (region);
}
/**
* Sets the receiver's minimum size to the size specified by the arguments.
* If the new minimum size is larger than the current size of the receiver,
* the receiver is resized to the new minimum size.
*
* @param width the new minimum width for the receiver
* @param height the new minimum height for the receiver
*
* @exception SWTException
*
*
* @since 3.1
*/
public void setMinimumSize (int width, int height) {
checkWidget();
int [] args = {OS.Pt_ARG_WINDOW_RENDER_FLAGS, 0, 0};
OS.PtGetResources (shellHandle, args.length / 3, args);
int flags = args [1];
int [] left = new int [1], top = new int [1];
int [] right = new int [1], bottom = new int [1];
OS.PtFrameSize (flags, 0, left, top, right, bottom);
width = Math.max (width - left [0] - right [0], 0);
height = Math.max (height - top [0] - bottom [0], 0);
args = new int [] {
OS.Pt_ARG_MIN_WIDTH, width, 0,
OS.Pt_ARG_MIN_HEIGHT, height, 0,
};
OS.PtSetResources (shellHandle, args.length / 3, args);
}
/**
* Sets the receiver's minimum size to the size specified by the argument.
* If the new minimum size is larger than the current size of the receiver,
* the receiver is resized to the new minimum size.
*
* @param size the new minimum size for the receiver
*
* @exception IllegalArgumentException
*
* @exception SWTException
*
*
* @since 3.1
*/
public void setMinimumSize (Point size) {
checkWidget();
if (size == null) error (SWT.ERROR_NULL_ARGUMENT);
setMinimumSize (size.x, size.y);
}
public void setText (String string) {
checkWidget();
if (string == null) error (SWT.ERROR_NULL_ARGUMENT);
text = string;
byte [] buffer = Converter.wcsToMbcs (null, string, true);
int ptr = OS.malloc (buffer.length);
OS.memmove (ptr, buffer, buffer.length);
OS.PtSetResource (shellHandle, OS.Pt_ARG_WINDOW_TITLE, ptr, 0);
OS.free (ptr);
}
public void setVisible (boolean visible) {
checkWidget();
if (visible == OS.PtWidgetIsRealized (shellHandle)) return;
/*
* Feature in Photon. It is not possible to show a PtWindow
* whose parent is not realized. The fix is to temporarily
* reparent the child shell to NULL and then realize the child
* shell.
*/
if (parent != null) {
Shell shell = parent.getShell ();
int parentHandle = shell.shellHandle;
if (!OS.PtWidgetIsRealized (parentHandle)) {
OS.PtReParentWidget (shellHandle, visible ? OS.Pt_NO_PARENT : parentHandle);
}
}
if (visible) {
int mask = SWT.PRIMARY_MODAL | SWT.APPLICATION_MODAL | SWT.SYSTEM_MODAL;
switch (style & mask) {
case SWT.PRIMARY_MODAL:
if (parent != null) {
int parentHandle = parent.getShell ().shellHandle;
blockedList = OS.PtBlockWindow (parentHandle, (short) 0, 0);
}
break;
case SWT.APPLICATION_MODAL:
case SWT.SYSTEM_MODAL:
blockedList = OS.PtBlockAllWindows (shellHandle, (short) 0, 0);
break;
}
} else {
if (blockedList != 0) OS.PtUnblockWindows (blockedList);
blockedList = 0;
}
int flags = visible ? 0 : OS.Pt_DELAY_REALIZE;
OS.PtSetResource (shellHandle, OS.Pt_ARG_FLAGS, flags, OS.Pt_DELAY_REALIZE);
if (visible) {
sendEvent (SWT.Show);
if (isDisposed ()) return;
OS.PtRealizeWidget (shellHandle);
} else {
OS.PtUnrealizeWidget (shellHandle);
sendEvent(SWT.Hide);
if (isDisposed ()) return;
}
/*
* Feature in Photon. When a shell is shown, it may have child
* shells that have been temporarily reparented to NULL because
* the child was shown before the parent. The fix is to reparent
* the child shells back to the correct parent.
*/
if (visible) {
Shell [] shells = getShells ();
for (int i=0; i