/*******************************************************************************

 * Copyright (c) 2000, 2007 IBM Corporation and others.

 * Portion Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).

 * 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

 *     Nokia Corporation - Qt implementation

 *******************************************************************************/

package org.eclipse.swt.widgets;

import org.eclipse.swt.SWT;

import org.eclipse.swt.events.SelectionListener;

import org.eclipse.swt.graphics.Image;

import org.eclipse.swt.graphics.Internal_GfxPackageSupport;

import org.eclipse.swt.internal.qt.OS;

import org.eclipse.swt.internal.qt.WidgetState;

/**

 * Instances of this class represent icons that can be placed on the

 * system tray or task bar status area.

 * <p>

 * <dl>

 * <dt><b>Styles:</b></dt>

 * <dd>(none)</dd>

 * <dt><b>Events:</b></dt>

 * <dd>DefaultSelection, MenuDetect, Selection</dd>

 * </dl>

 * </p><p>

 * IMPORTANT: This class is <em>not</em> intended to be subclassed.

 * </p>

 * 

 * @since 3.0

 */

public class TrayItem extends Item {

    Tray parent;

    String toolTipText;

/**

 * Constructs a new instance of this class given its parent

 * (which must be a <code>Tray</code>) and a style value

 * describing its behavior and appearance. The item is added

 * to the end of the items maintained by its parent.

 * <p>

 * The style value is either one of the style constants defined in

 * class <code>SWT</code> which is applicable to instances of this

 * class, or must be built by <em>bitwise OR</em>'ing together 

 * (that is, using the <code>int</code> "|" operator) two or more

 * of those <code>SWT</code> style constants. The class description

 * lists the style constants that are applicable to the class.

 * Style bits are also inherited from superclasses.

 * </p>

 *

 * @param parent a composite control which will be the parent of the new instance (cannot be null)

 * @param style the style of control to construct

 *

 * @exception IllegalArgumentException <ul>

 *    <li>ERROR_NULL_ARGUMENT - if the parent is null</li>

 * </ul>

 * @exception SWTException <ul>

 *    <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>

 *    <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li>

 * </ul>

 *

 * @see SWT

 * @see Widget#checkSubclass

 * @see Widget#getStyle

 */

public TrayItem (Tray parent, int style) {

    super (parent, style);

    this.parent = parent;

    createWidget (parent.getItemCount ());

}

/**

 * Adds the listener to the collection of listeners who will

 * be notified when the receiver is selected by the user, by sending

 * it one of the messages defined in the <code>SelectionListener</code>

 * interface.

 * <p>

 * <code>widgetSelected</code> is called when the receiver is selected

 * <code>widgetDefaultSelected</code> is called when the receiver is double-clicked

 * </p>

 *

 * @param listener the listener which should be notified when the receiver is selected by the user

 *

 * @exception IllegalArgumentException <ul>

 *    <li>ERROR_NULL_ARGUMENT - if the listener is null</li>

 * </ul>

 * @exception SWTException <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>

 *

 * @see SelectionListener

 * @see #removeSelectionListener

 * @see SelectionEvent

 */

public void addSelectionListener(SelectionListener listener) {

    checkWidget ();

    if (listener == null) error (SWT.ERROR_NULL_ARGUMENT);

    TypedListener typedListener = new TypedListener (listener);

    addListener (SWT.Selection, typedListener);

    addListener (SWT.DefaultSelection, typedListener);

}

protected void checkSubclass () {

    if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS);

}

void createWidget (int index) {

    super.createWidget (index);

    parent.createItem (this, index);

    OS.QSystemTrayIcon_setVisible(handle, true);

}

void createHandle_pp (int index) {

    getDisplay();

    topHandle = handle = OS.QSystemTrayIcon_new(Display.handle);

    state |= WidgetState.HANDLE;

}

void releaseParent_pp (){

    parent.destroyItem (this);

}

/**

 * Returns the receiver's parent, which must be a <code>Tray</code>.

 *

 * @return the receiver's parent

 *

 * @exception SWTException <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.2

 */

public Tray getParent () {

    checkWidget ();

    return parent;

}

/**

 * Returns the receiver's tool tip text, or null if it has

 * not been set.

 *

 * @return the receiver's tool tip text

 *

 * @exception SWTException <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>

 */

public String getToolTipText () {

    checkWidget ();

    return toolTipText;

}

void qt_signal_tray_activated(int reason) {

    switch (reason ) {

    case OS.QT_TRAY_REASON_CONTEXT:

        sendEvent (SWT.MenuDetect);

        break;

    case OS.QT_TRAY_REASON_TRIGGER:

        sendEvent (SWT.Selection);

        break;

    case OS.QT_TRAY_REASON_DOUBLECLICK:

        sendEvent (SWT.DefaultSelection);

        break;

    default:

        break;

    }

}

void hookEvents_pp () {

    int activatedProxy = OS.SignalHandler_new(handle, OS.QSIGNAL_TRAY_ACTIVATED);

    OS.QObject_connectOrThrow(handle, "activated(QSystemTrayIcon::ActivationReason)", activatedProxy, "widgetSignal(QSystemTrayIcon::ActivationReason)", OS.QT_AUTOCONNECTION);

 }

/**

 * Returns <code>true</code> if the receiver is visible and 

 * <code>false</code> otherwise.

 *

 * @return the receiver's visibility

 *

 * @exception SWTException <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>

 */

public boolean getVisible () {

    checkWidget ();

    return OS.QSystemTrayIcon_isVisible(handle);

}

void releaseWidget_pp () {

    super.releaseWidget_pp ();

    toolTipText = null;

    parent = null;

}

/**

 * Removes the listener from the collection of listeners who will

 * be notified when the receiver is selected by the user.

 *

 * @param listener the listener which should no longer be notified

 *

 * @exception IllegalArgumentException <ul>

 *    <li>ERROR_NULL_ARGUMENT - if the listener is null</li>

 * </ul>

 * @exception SWTException <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>

 *

 * @see SelectionListener

 * @see #addSelectionListener

 */

public void removeSelectionListener (SelectionListener listener) {

    checkWidget ();

    if (listener == null) error (SWT.ERROR_NULL_ARGUMENT);

    if (eventTable == null) return;

    eventTable.unhook (SWT.Selection, listener);

    eventTable.unhook (SWT.DefaultSelection, listener);

}

/**

 * Sets the receiver's image.

 *

 * @param image the new image

 *

 * @exception IllegalArgumentException <ul>

 *    <li>ERROR_INVALID_ARGUMENT - if the image has been disposed</li>

 * </ul>

 * @exception SWTException <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>

 */

public void setImage (Image image) {

    checkWidget ();

    if (image != null && image.isDisposed ()) error (SWT.ERROR_INVALID_ARGUMENT);

    this.image = image;

    if (image != null ) {

        OS.QSystemTrayIcon_setIcon(handle, Internal_GfxPackageSupport.getIconHandle(image));

    } else {

        OS.QSystemTrayIcon_setIcon(handle, Internal_GfxPackageSupport.getNullIconHandle());

    }

}

/**

 * Sets the receiver's tool tip text to the argument, which

 * may be null indicating that no tool tip text should be shown.

 *

 * @param value the new tool tip text (or null)

 *

 * @exception SWTException <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>

 */

public void setToolTipText (String string) {

    checkWidget ();

    toolTipText = string;

    OS.QSystemTrayIcon_setToolTip( handle, string);

}

/**

 * Makes the receiver visible if the argument is <code>true</code>,

 * and makes it invisible otherwise. 

 *

 * @param visible the new visibility state

 *

 * @exception SWTException <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>

 */

public void setVisible (boolean visible) {

    checkWidget ();

    if (OS.QSystemTrayIcon_isVisible(handle) == visible) return;

    if (visible) {

        /*

        * It is possible (but unlikely), that application

        * code could have disposed the widget in the show

        * event.  If this happens, just return.

        */

        sendEvent (SWT.Show);

        if (isDisposed ()) return;

    } else {

        sendEvent (SWT.Hide);

    }

    OS.QSystemTrayIcon_setVisible(handle, visible);

}

}