projects/dwt-linux: dwt/widgets/Shell.d comparison

comparison dwt/widgets/Shell.d @ 259:c0d810de7093

Update SWT 3.4M7 to 3.4

author	Frank Benoit <benoit@tionex.de>
date	Sun, 29 Jun 2008 14:33:38 +0200
parents	5a30aa9820f3
children

comparison

equal deleted inserted replaced

-:cc1d3de0e80b
+:c0d810de7093
 /*******************************************************************************
-* Copyright (c) 2000, 2007 IBM Corporation and others.
+* Copyright (c) 2000, 2008 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
 *
 * IMPORTANT: This class is not intended to be subclassed.
 * </p>
 *
 * @see Decorations
 * @see DWT
+* @see <a href="http://www.eclipse.org/swt/snippets/#shell">Shell snippets</a>
+* @see <a href="http://www.eclipse.org/swt/examples.php">DWT Example: ControlExample</a>
+* @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
 */
 public class Shell : Decorations {
 alias Decorations.createHandle createHandle;
 alias Decorations.fixStyle fixStyle;
 public static Shell gtk_new (Display display, GtkWidget* handle) {
 return new Shell (display, null, DWT.NO_TRIM, handle, true);
 }
+/**
+* Invokes platform specific functionality to allocate a new shell
+* that is not embedded.
+* <p>
+* <b>IMPORTANT:</b> This method is <em>not</em> part of the public
+* API for <code>Shell</code>. It is marked public only so that it
+* can be shared within the packages provided by DWT. It is not
+* available on all platforms, and should never be called from
+* application code.
+* </p>
+*
+* @param display the display for the shell
+* @param handle the handle for the shell
+* @return a new shell object containing the specified display and handle
+*
+* @since 3.3
+*/
 public static Shell internal_new (Display display, GtkWidget* handle) {
 return new Shell (display, null, DWT.NO_TRIM, handle, false);
 }
 static int checkStyle (int style) {
 allocation.width = width;
 allocation.height = height;
 OS.gtk_widget_size_allocate (cast(GtkWidget*)vboxHandle, &allocation);
 }
+/**
+* Returns the receiver's alpha value. The alpha value
+* is between 0 (transparent) and 255 (opaque).
+*
+* @return the alpha value
+*
+* @exception DWTException <ul>
+*    <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
+*    <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
+* </ul>
+*
+* @since 3.4
+*/
 public int getAlpha () {
 checkWidget ();
 if (OS.GTK_VERSION >= OS.buildVERSION (2, 12, 0)) {
 if (OS.gtk_widget_is_composited (shellHandle)) {
 return cast(int) (OS.gtk_window_get_opacity (shellHandle) * 255);
 }
 }
 return 255;
 }
+/**
+* Returns <code>true</code> if the receiver is currently
+* in fullscreen state, and false otherwise.
+* <p>
+*
+* @return the fullscreen state
+*
+* @exception DWTException <ul>
+*    <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
+*    <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
+* </ul>
+*
+* @since 3.4
+*/
 public bool getFullScreen () {
 checkWidget();
 return fullScreen;
 }
 activate [i].sendEvent (DWT.Activate);
 }
 }
 }
+/**
+* Sets the receiver's alpha value which must be
+* between 0 (transparent) and 255 (opaque).
+* <p>
+* This operation requires the operating system's advanced
+* widgets subsystem which may not be available on some
+* platforms.
+* </p>
+* @param alpha the alpha value
+*
+* @exception DWTException <ul>
+*    <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
+*    <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
+* </ul>
+*
+* @since 3.4
+*/
 public void setAlpha (int alpha) {
 checkWidget ();
 if (OS.GTK_VERSION >= OS.buildVERSION (2, 12, 0)) {
 if (OS.gtk_widget_is_composited (shellHandle)) {
 alpha &= 0xFF;
 if (enabled && display.activeShell is this) {
 if (!restoreFocus ()) traverseGroup (false);
 }
 }
+/**
+* Sets the full screen state of the receiver.
+* If the argument is <code>true</code> causes the receiver
+* to switch to the full screen state, and if the argument is
+* <code>false</code> and the receiver was previously switched
+* into full screen state, causes the receiver to switch back
+* to either the maximmized or normal states.
+* <p>
+* Note: The result of intermixing calls to <code>setFullScreen(true)</code>,
+* <code>setMaximized(true)</code> and <code>setMinimized(true)</code> will
+* vary by platform. Typically, the behavior will match the platform user's
+* expectations, but not always. This should be avoided if possible.
+* </p>
+*
+* @param fullScreen the new fullscreen state
+*
+* @exception DWTException <ul>
+*    <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
+*    <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
+* </ul>
+*
+* @since 3.4
+*/
 public void setFullScreen (bool fullScreen) {
 checkWidget();
 if (fullScreen) {
 OS.gtk_window_fullscreen (shellHandle);
 } else {

Mercurial > projects > dwt-linux

comparison dwt/widgets/Shell.d @ 259:c0d810de7093