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

 * Copyright (c) 2006, 2010 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:

 *     Nokia Corporation - S60 implementation

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

#ifndef ESWTMOBILEEXTENSIONS_H

#define ESWTMOBILEEXTENSIONS_H

#include "eswt.h"

#include "eswtwidgetscore.h"

class MSwtMobileShell

{

public:

    /**

     * Add the scan code the array of keys pressed.

     */

    virtual void AddKeyStateL(TInt aScanCode) =0;

    /**

     * Change the trim/style of the MSwtMobileShell

     */

    virtual void ChangeTrimL(TInt aStyle, TInt aStatusStyle) =0;

    /**

     * Returns a pointer to the shell member.

     */

    virtual const MSwtShell* Shell() const =0;

    /**

     * Returns ETrue if the key corresponding to aSwtKeyCode

     * has been pressed since the last call to GetKeyState();

     * If the current MSwtMobileShell is not

     * the active MSwtMobileShell.

     */

    virtual TBool GetKeyState(TInt aSwtKeyCode) =0;

    /**

     * Set the text displayed in the status pane.

     */

    virtual void SetStatusTextL(const TDesC& aText) =0;

    /**

     * Get the text displayed in the status pane.

     */

    virtual const TDesC* GetStatusText() const =0;

};

/**

 * Interface class for the org.eclipse.ercp.swt.mobile.Input class.

 */

class MSwtInput

{

public:

    enum TInputType

    {

        EUnknownInput,      // Unknown input

        ESoftKeys,          // Input device has one or more hardware keys whose meaning can be configured

        EKeyPad,            // Input device has hardware keys labeled 0 - 9, *, and #

        ELimitedKeyboard,   // Input device has more hardware keys than a keypad, but fewer than a full keyboard

        EFullKeyboard       // Input device has hardware keys typical in a full keyboard

    };

protected:

    virtual ~MSwtInput() {} // Made protected to prevent destruction through the interface

public:

    /**

     * Disposes of ( i.e. destroys ) the Input

     * @return The Java peer associated with this object

     */

    virtual TSwtPeer Dispose() =0;

    /**

     * Returns the location of the input device.

     * @return The location type of the input.

     */

    virtual TInt GetLocation() =0;

    /**

     * Returns the type of the input device.

     * @return The type of the input.

     */

    virtual TInt GetType() =0;

};

/**

 * Interface class for the org.eclipse.ercp.swt.mobile.Screen class.

 */

class MSwtScreen

{

public:

    enum TScreenType

    {

        EPrimary = 1,   // One primary screen may be active at a time.

        ESecondary,     // Multiple secondary screens may be simultaneously active.

        EStatus         // Sub type of secondary screen that shows minimal content for notification purposes.

    };

    enum TOrientationType

    {

        EPortrait = 0,  // Indicates text is normally written across the shortest width.

        ELandscape      // Indicates text is normally written across the longest width.

    };

    /**

     * Differents values of the EventType.

     */

    enum TScreenEvent

    {

        KEventScreenActivated = 1, // Event type when the screen is actived.

        KEventScreenDeactivated, // Event type when the screen is desactived.

        KEventScreenOrientationChanged // Event type when the orientation screen change.

    };

protected:

    virtual ~MSwtScreen() {} // Made protected to prevent destruction through the interface

public:

    /**

     * Disposes of ( i.e. destroys ) the Screen

     * @return The Java peer associated with this object

     */

    virtual TSwtPeer Dispose() =0;

    /**

     * Returns the bounds of the screen.

     * @return The bounds of the screen

     */

    virtual TRect GetBounds() =0;

    /**

     * Returns the color depth of the screen in bits per pixel.

     * @return The color depth.

     */

    virtual TInt GetColorDepth() =0;

    /**

     * Returns the location of the screen.

     * @return The location type of the screen.

     *         The value is one of MSwtMobileDevice::TLocationType

     */

    virtual TInt GetLocation() =0;

    /**

     * Returns the screen orientation.

     * @return The screen orientation. The value is a TOrientationType.

     */

    virtual TInt GetOrientation() =0;

    /**

     * Returns the usage type of the screen.

     * @return The type of the screen. The value is a TScreenType

     */

    virtual TInt GetUsage() =0;

    /**

     * Returns whether the screen is currently active.

     * That is, whether it is powered up and contents are visible to the user.

     * @return The screen's status.

     */

    virtual TBool IsActive() =0;

    /**

     * Returns whether the screen has touch screen capability.

     * @return The touch capability

     */

    virtual TBool IsTouchScreen() =0;

    /**

     * Sets the screen orientation.

     * @param aOrientation The new orientation.

     */

    virtual void SetOrientationL(TInt aOrientation) =0;

};

/**

 * MSwtMobileDeviceObserver

 */

class MSwtMobileDeviceObserver

{

public:

    virtual void ScreenActivatedL(TInt aScreenId) = 0;

    virtual void ScreenDeactivatedL(TInt aScreenId) = 0;

};

/**

 * Interface class for the org.eclipse.ercp.swt.mobile.MobileDevice class.

 */

class MSwtMobileDevice

{

public:

    enum TLocationType

    {

        ELocal,     // Feature which is permanently attached to the mobile device and always available

        EInternal,  // Local feature which is only available when mobile device is opened

        EExternal,  // Local feature which is only available when mobile device is closed

        ERemote     // Feature which is not part of the mobile device unless connected via wire or wireless signal

    };

    enum TEventType

    {

        EEventOpened  = 1,

        EEventClosed  = 2,

        EEventAdded   = 3,

        EEventRemoved = 4

    };

    enum TAlertLevel

    {

        EAlertLowImportance  = 1,

        EAlertHighImportance = 2,

        EAlertCritical       = 3

    };

protected:

    virtual ~MSwtMobileDevice() {} // Made protected to prevent destruction through the interface

public:

    /**

     * Add observer

     */

    virtual TBool AddObserverL(const MSwtMobileDeviceObserver* aObserver) = 0;

    /**

     * Alerts the user using device specific mechanisms such as sounds,

     * flashing, or vibration.

     * aLevel must be one of ALERT_LOW_IMPORTANCE,

     * ALERT_HIGH_IMPORTANCE or ALERT_CRITICAL. The

     * method maps these levels to device specific features that may also be

     * dependent upon user configuration or current profile.

     * @param aLevel Constant describing the importance of the alert.

     */

    virtual void Alert(TAlertLevel aLevel) =0;

    /**

     * Disposes of ( i.e. destroys ) the mobile device.

     * @return The Java peer associated with this object.

     */

    virtual TSwtPeer Dispose() =0;

    /**

     * Returns the number of Input objects available on the device.

     * @return This number.

     */

    virtual TInt GetInputNumber() const =0;

    /**

     * Returns the number of Screen objects available on the device.

     * @return This number.

     */

    virtual TInt GetScreenNumber() const =0;

    /**

     * Returns whether device is opened.

     * For devices that have no internal screens or input, the  method always returns ETrue.

     * @return The device's open status.

     */

    virtual TBool IsOpen() const = 0;

    /**

     * Remove observer

     */

    virtual TBool RemoveObserver(const MSwtMobileDeviceObserver* aObserver) = 0;

};

/**

 * Interface class for the org.eclipse.ercp.swt.mobile.CaptionedControl class.

 * A class that implements MSwtCaptionedControl must also implement

 * MSwtComposite.

 */

class MSwtCaptionedControl

{

protected:

    virtual ~MSwtCaptionedControl() {} // Made protected to prevent destruction through the interface

public:

    /**

     * Returns the MSwtComposite interface

     */

    virtual MSwtComposite* Composite() const =0;

    /**

     * Sets the caption label.

     * @param aString The caption label.

     */

    virtual void SetTextL(const TDesC& aString) =0;

    /**

     * Sets the trailing label.

     * @param aString The trailing label.

     */

    virtual void SetTrailingTextL(const TDesC& aString) =0;

    /**

     * Gets the caption label.

     * @return The caption label.

     */

    virtual const TDesC* GetText() const =0;

    /**

     * Gets the trailing label.

     * @return The trailing label.

     */

    virtual const TDesC* GetTrailingText() const =0;

    /**

     * Sets an image as the icon.

     * @param aImage The image ( may be NULL ).

     */

    virtual void SetImageL(MSwtImage* aImage) =0;

    /**

     * Sets the preferred size of CaptionedControl's child

     * @param aSize The child's size.

     */

    virtual void SetChildPreferredSize(const TSize& aSize) =0;

    /**

     * Returns the image if the Captioned control has one set.

     * @return CCoeControl pointer to the image or NULL if there is no image.

     */

    virtual const CCoeControl* GetImageControl() const =0;

};

/**

 * Interface class for the internal pager of the

 * org.eclipse.ercp.swt.mobile.MultiPageDialog class.

 *

 */

class MSwtMultiPagePager

{

protected:

    virtual ~MSwtMultiPagePager() {} // Made protected to prevent destruction through the interface

public:

    /**

     * Returns the MSwtComposite interface

     */

    virtual MSwtComposite* Composite() =0;

    /**

     * Displays the page specified by its index.

     * A Selection event is post if the current page is changed.

     * @param aIndex The 0-based index of the page to display.

     *               The first page is at the index 0;

     */

    virtual void DisplayPage(TInt aIndex) =0;

    /**

     * Gets the margins of the pager.

     */

    virtual TMargins GetPagerMargins() const =0;

    /**

     * Gets the margins of the MultiPageDialog.

     */

    virtual TMargins GetDialogMargins() const =0;

};

/**

 * Interface class for the multipage tab group of the

 * org.eclipse.ercp.swt.mobile.MultiPageDialog class.

 *

 */

class MSwtMultiPageTabGroup

{

protected:

    virtual ~MSwtMultiPageTabGroup() {} // Made protected to prevent destruction through the interface

public:

    /**

     * Creates a new tab item.

     * @param aTitle The title of the new tab item.

     * @param aImage Image or icon of the tab item. Not used.

     * @return The 0-based index of the active page.

     *         The first page is at the index 0;

     */

    virtual TInt AddPageL(const TDesC& aTitle, MSwtImage* aImage) =0;

    /**

     * Returns the MSwtControl interface

     */

    virtual MSwtControl* Control() =0;

    /**

     * Removes a page.

     * @param aIndex The 0-based index of the page to remove.

     *               The first page is at the index 0;

     * @return The 0-based index of the active page.

     *         The first page is at the index 0;

     */

    virtual TInt RemovePage(TInt aIndex) =0;

    /**

     * Changes the active page to display.

     * @param aIndex The 0-based index of the page to be active.

     *               The first page is at the index 0;

     * @return The 0-based index of the active page.

     *         The first page is at the index 0;

     */

    virtual TInt SelectPage(TInt aIndex) =0;

    /**

     * Sets the pager the MSwtMultiPageTabGroup

     * @return aPager A pointer to the pager.

     */

    virtual void SetPager(MSwtMultiPagePager* aPager) =0;

    /**

     * Sets the title/label of a tab item.

     * @param aIndex The index of the tab item.

     * @param aText  The title

     */

    virtual void SetTabTitleL(TInt aIndex, const TDesC& aText) =0;

};

/**

 * Interface class for the

 * org.eclipse.ercp.swt.mobile.MultiPageDialog class.

 */

class MSwtMultiPageDialog

{

protected:

    virtual ~MSwtMultiPageDialog() {} // Made protected to prevent destruction through the interface

public:

    /**

     * Returns the MSwtControl interface

     */

    virtual MSwtControl* Control() =0;

    /**

     * Closes the MultiPageDialog.

     */

    virtual void Close() =0;

    /**

     * Creates a new tab item.

     * @param aComposite The composite for this page.

     * @param aTitle The title of the new tab item.

     * @param aImage Image or icon of the tab item. Not used.

     */

    virtual void CreatePageL(MSwtComposite* aComposite, const TDesC& aTitle, MSwtImage* aImage) =0;

    /**

     * Deletes a page.

     * @param aIndex The 0-based index of the page to remove.

     *        The first page is at the index 0;

     * @return The 0-based index of the active page.

     *        The first page is at the index 0;

     */

    virtual void DeletePageL(TInt aIndex) =0;

    /**

     * Returns the index of the selected page.

     */

    virtual TInt GetSelectedIndex() =0;

    /**

     * Opens a MultiPageDialog

     */

    virtual void OpenL() =0;

    /**

     * Changes the active page to display.

     * @param aIndex The 0-based index of the page to be active.

     *        The first page is at the index 0;

     */

    virtual void SetSelection(TInt aIndex) =0;

    /**

     * Sets the text and image of a tab item.

     */

    virtual void SetTitleAndImageL(TInt aIndex, const TDesC& aText, MSwtImage* aImage) =0;

    /**

     * Sets the title/label of a tab item.

     * @param aIndex The index of the tab item.

     */

    virtual void SetTitleL(TInt aIndex, const TDesC& aText) =0;

};

/**

 * Interface class for the org.eclipse.ercp.swt.mobile.CaptionedControl class.

 *

 * A class that implements MSwtCaptionedControl must also implement

 * MSwtComposite.

 */

class MSwtConstrainedText

{

public:

    enum TConstraint

    {

        ENumeric     = 1,

        EDecimal     = 2,

        EPhoneNumber = 4

    };

protected:

    virtual ~MSwtConstrainedText() {}; // Made protected to prevent destruction through the interface

public:

    /**

     * Returns the MSwtControl interface

     */

    virtual MSwtControl* Control() =0;

    /**