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

 * Copyright (c) 2005, 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 ESWT_H

#define ESWT_H

#include <coedef.h>

#include <eikenv.h>

#include <w32std.h>

class _jweak;

class CCoeControl;

class CEikAppUi;

class CSwtJavaBufferDrawer;

class MSwtMenuArranger;

class MSwtCommandArranger;

class MSwtMobileDevice;

class MSwtComposite;

class MSwtControl;

class MSwtFactory;

class MSwtDevice;

class MSwtFont;

class MSwtImage;

class MSwtText;

class MSwtUiUtils;

class MSwtVerifyEventObserver;

class MSwtBrowser;

class MSwtMenu;

/*

 */

const TInt KSwtStyleBar              = 1 << 1;

const TInt KSwtStylePopUp            = 1 << 3;

const TInt KSwtStyleSeparator        = 1 << 1;

const TInt KSwtStyleToggle           = 1 << 1;

const TInt KSwtStylePush             = 1 << 3;

const TInt KSwtStyleRadio            = 1 << 4;

const TInt KSwtStyleCheck            = 1 << 5;

const TInt KSwtStyleCascade          = 1 << 6;

const TInt KSwtStyleMulti            = 1 << 1;

const TInt KSwtStyleSingle           = 1 << 2;

const TInt KSwtStyleReadOnly         = 1 << 3;

const TInt KSwtStyleWrap             = 1 << 6;

const TInt KSwtStylePassword         = 1 << 22;

const TInt KSwtStyleShadowIn         = 1 << 2;

const TInt KSwtStyleShadowOut        = 1 << 3;

const TInt KSwtStyleIndeterminate    = 1 << 1;

const TInt KSwtStyleNoTrim           = 1 << 3;

const TInt KSwtStyleTitle            = 1 << 5;

const TInt KSwtStyleHScroll          = 1 << 8;

const TInt KSwtStyleVScroll          = 1 << 9;

const TInt KSwtStyleBorder           = 1 << 11;

const TInt KSwtStyleOnTop            = 1 << 14;

const TInt KSwtStyleModeless         = 0;

const TInt KSwtStylePrimaryModal     = 1 << 15;

const TInt KSwtStyleApplicationModal = 1 << 16;

const TInt KSwtStyleSystemModal      = 1 << 17;

const TInt KSwtStyleHideSelection    = 1 << 15;

const TInt KSwtStyleFullSelection    = 1 << 16;

const TInt KSwtStyleFlat             = 1 << 23;

const TInt KSwtStyleSmooth           = 1 << 16;

const TInt KSwtStyleNoBackground     = 1 << 18;

const TInt KSwtStyleNoRedrawResize   = 1 << 20;

const TInt KSwtStyleNoMergePaints    = 1 << 21;

const TInt KSwtStyleNoRadioGroup     = 1 << 22;

const TInt KSwtStyleLeftToRight      = 1 << 25;

const TInt KSwtStyleRightToLeft      = 1 << 26;

const TInt KSwtStyleUp               = 1 << 7;

const TInt KSwtStyleDown             = 1 << 10;

const TInt KSwtStyleLead             = 1 << 14;

const TInt KSwtStyleTrail            = 1 << 17;

const TInt KSwtStyleCenter           = 1 << 24;

const TInt KSwtStyleHorizontal       = 1 << 8;

const TInt KSwtStyleVertical         = 1 << 9;

const TInt KSwtStyleOpen             = 1 << 12;

const TInt KSwtStyleSave             = 1 << 13;

/**

 * Binary mask for the modality styles

 */

const TInt KSwtModalityMask = KSwtStylePrimaryModal | KSwtStyleApplicationModal | KSwtStyleSystemModal;

/**

 * Binary mask for the horizontal alignment styles

 */

const TInt KSwtAlignmentMask = KSwtStyleLead | KSwtStyleCenter | KSwtStyleTrail;

/**

 * Binary mask for the orientation styles

 */

const TInt KSwtOrientationMask = KSwtStyleLeftToRight | KSwtStyleRightToLeft;

/**

 * Type Ids of data contains in the clipboard

 */

const TInt KSwtClipboardTypeByte       = 1;

const TInt KSwtClipboardTypePlaintText = 2;

/*

 * Message box styles

 */

const TInt KSwtMsgBoxStyleError       = 1;       // Message box style for error icon behaviour

const TInt KSwtMsgBoxStyleInformation = 1 <<  1; // Message box style for an information icon

const TInt KSwtMsgBoxStyleQuestion    = 1 <<  2; // Message box style for a question icon

const TInt KSwtMsgBoxStyleWarning     = 1 <<  3; // Message box style for a warning icon

const TInt KSwtMsgBoxStyleWorking     = 1 <<  4; // Message box style for a "working" icon

const TInt KSwtMsgBoxStyleOk          = 1 <<  5; // Message box style for an OK button

const TInt KSwtMsgBoxStyleYes         = 1 <<  6; // Message box style for a YES button

const TInt KSwtMsgBoxStyleNo          = 1 <<  7; // Message box style for a NO button

const TInt KSwtMsgBoxStyleCancel      = 1 <<  8; // Message box style for a CANCEL button

const TInt KSwtMsgBoxStyleRetry       = 1 << 10; // Message box style for a RETRY button

/**

 * Binary mask for a message box's buttons

 */

const TInt KSwtMsgBoxButtonMask = KSwtMsgBoxStyleOk | KSwtMsgBoxStyleYes | KSwtMsgBoxStyleNo | KSwtMsgBoxStyleCancel | KSwtMsgBoxStyleRetry;

/**

 * Pre-combined message box buttons (the only legal combinations)

 */

enum TMsgBoxButtons

{

    ESwtMsgBoxBtnYesNo       = KSwtMsgBoxStyleYes   | KSwtMsgBoxStyleNo,

    ESwtMsgBoxBtnYesNoCancel = KSwtMsgBoxStyleYes   | KSwtMsgBoxStyleNo | KSwtMsgBoxStyleCancel,

    ESwtMsgBoxBtnOk          = KSwtMsgBoxStyleOk,

    ESwtMsgBoxBtnOkCancel    = KSwtMsgBoxStyleOk    | KSwtMsgBoxStyleCancel,

    ESwtMsgBoxBtnRetryCancel = KSwtMsgBoxStyleRetry | KSwtMsgBoxStyleCancel

};

/**

 * Retrieves the message box's button from it's style

 */

inline TMsgBoxButtons SwtMsgBoxButtons(TInt aMsgBoxStyle)

{

    return static_cast<TMsgBoxButtons>(aMsgBoxStyle & KSwtMsgBoxButtonMask);

}

/**

 */

enum TSwtError

{

    ESwtErrorUnspecified         =  1,

    ESwtErrorNoHandles           =  2,

    ESwtErrorNullArgument        =  4,

    ESwtErrorInvalidArgument     =  5,

    ESwtErrorInvalidRange        =  6,

    ESwtErrorCannotBeZero        =  7,

    ESwtErrorCannotGetSelection  =  9,

    ESwtErrorItemNotAdded        = 14,

    ESwtErrorThreadInvalidAccess = 22,

    ESwtErrorCannotSetSelection  = 28,

    ESwtErrorUnsupportedDepth    = 38,

    ESwtErrorIO                  = 39,

    ESwtErrorInvalidImage        = 40,

    ESwtErrorFailedLoadLibrary   = 47

};

/*

 * SWT font style

 */

const TInt KSwtNormal = 0;

const TInt KSwtBold   = 1 << 0;

const TInt KSwtItalic = 1 << 1;

/**

 */

enum TSwtEventType

{

    ESwtEventNone             =  0,

    ESwtEventKeyDown          =  1,

    ESwtEventKeyUp            =  2,

    ESwtEventMouseDown        =  3,

    ESwtEventMouseUp          =  4,

    ESwtEventMouseMove        =  5,

    ESwtEventMouseDoubleClick =  8,

    ESwtEventPaint            =  9,

    ESwtEventMove             = 10,

    ESwtEventResize           = 11,

    ESwtEventDispose          = 12,

    ESwtEventSelection        = 13,

    ESwtEventDefaultSelection = 14,

    ESwtEventFocusIn          = 15,

    ESwtEventFocusOut         = 16,

    ESwtEventExpand           = 17,

    ESwtEventCollapse         = 18,

    ESwtEventClose            = 21,

    ESwtEventShow             = 22,

    ESwtEventHide             = 23,

    ESwtEventModify           = 24,

    ESwtEventVerify           = 25,

    ESwtEventActivate         = 26,

    ESwtEventDeactivate       = 27,

    ESwtEventTraverse         = 31,

    ESwtEventSettings         = 39, //added in eSWT 1.1

    // Custom events

    ESwtEventLocation         = 1000,

    ESwtEventProgress         = 1002,

    ESwtEventStatusText       = 1003,

    ESwtEventTitle            = 1004,

    ESwtEventForeground       = 1006,

    ESwtEventDialogStringResult = 1007,

    ESwtEventDialogIntegerResult = 1008,

    ESwtEventDialogRgbResult  = 1009,

    ESwtEventShowFocusedControl = 1010

};

/**

 * Traversal detail

 */

enum TSwtTraversal

{

    ESwtTraverseNone          = 0,

    ESwtTraverseEscape        = 1 << 1,

    ESwtTraverseReturn        = 1 << 2,

    ESwtTraverseTabPrevious   = 1 << 3,

    ESwtTraverseTabNext       = 1 << 4,

    ESwtTraverseArrowPrevious = 1 << 5,

    ESwtTraverseArrowNext     = 1 << 6,

    ESwtTraverseMnemonic      = 1 << 7,

    ESwtTraversePagePrevious  = 1 << 8,

    ESwtTraversePageNext      = 1 << 9,

    ESwtTraverseParent        = 1 << 10 // native internal traversal type

};

enum TSwtBrCallBackOperationType

{

    ESwtBrDoNothing     = 0,

    ESwtBrLoadUrl       = 1 << 1,

    ESwtBrGoBack        = 1 << 2,

    ESwtBrGoForward     = 1 << 3

};

/*

 * SWT key modifiers

 */

const TInt KSwtModifierAlt     = 1 << 16;

const TInt KSwtModifierShift   = 1 << 17;

const TInt KSwtModifierControl = 1 << 18;

const TInt KSwtModifierCommand = 1 << 22;

const TInt KSwtModifierMask    = KSwtModifierAlt | KSwtModifierShift | KSwtModifierControl | KSwtModifierCommand;

/*

 * Mouse buttons

 */

const TInt KSwtButton1    = 1 << 19;

const TInt KSwtButton2    = 1 << 20;

const TInt KSwtButton3    = 1 << 21;

const TInt KSwtButtonMask = KSwtButton1 | KSwtButton2 | KSwtButton3;

const TInt KSwtMouseButton1 = 1;

const TInt KSwtMouseButton2 = 2;

const TInt KSwtMouseButton3 = 3;

/**

 * A constant known to be zero (0), used in operations which take bit

 *        flags to indicate that "no bits are set".

 */

const TInt KSwtNone = 0;

/**

 * Indicates that a user-interface component is being dragged, for

 *        example dragging the thumb of a scroll bar.

 */

const TInt KSwtDrag = 1;

/**

 * Indicates that a default should be used.

 */

const TInt KSwtDefault = -1;

/**

 * Accelerator constant used to differentiate a key code from a Unicode

 *        character.

 */

const TInt KSwtKeycodeBit = (1 << 24);

/**

 * Accelerator constant used to extract the key stroke portion of an

 *        accelerator.

 */

const TInt KSwtKeyMask = KSwtKeycodeBit + 0xFFFF;

/**

 * constant used to to differentiate  symbian scancode from to a Unicode

 * character.

 */

const TInt KSwtScanCodeBase = (1 << 25);

/**

 * SWT key code

 */

enum TSwtKey

{

    ESwtKeyArrowUp        = KSwtKeycodeBit +  1,

    ESwtKeyArrowDown      = KSwtKeycodeBit +  2,

    ESwtKeyArrowLeft      = KSwtKeycodeBit +  3,

    ESwtKeyArrowRight     = KSwtKeycodeBit +  4,

    ESwtKeyPageUp         = KSwtKeycodeBit +  5,

    ESwtKeyPageDown       = KSwtKeycodeBit +  6,

    ESwtKeyHome           = KSwtKeycodeBit +  7,

    ESwtKeyEnd            = KSwtKeycodeBit +  8,

    ESwtKeyInsert         = KSwtKeycodeBit +  9,

    ESwtKeyF1             = KSwtKeycodeBit + 10,

    ESwtKeyF2             = KSwtKeycodeBit + 11,

    ESwtKeyF3             = KSwtKeycodeBit + 12,

    ESwtKeyF4             = KSwtKeycodeBit + 13,

    ESwtKeyF5             = KSwtKeycodeBit + 14,

    ESwtKeyF6             = KSwtKeycodeBit + 15,

    ESwtKeyF7             = KSwtKeycodeBit + 16,

    ESwtKeyF8             = KSwtKeycodeBit + 17,

    ESwtKeyF9             = KSwtKeycodeBit + 18,

    ESwtKeyF10            = KSwtKeycodeBit + 19,

    ESwtKeyF11            = KSwtKeycodeBit + 20,

    ESwtKeyF12            = KSwtKeycodeBit + 21,

    ESwtKeyF13            = KSwtKeycodeBit + 22,

    ESwtKeyF14            = KSwtKeycodeBit + 23,

    ESwtKeyF15            = KSwtKeycodeBit + 24,

    ESwtKeyKeypadMultiply = KSwtKeycodeBit + 42,

    ESwtKeyKeypadAdd      = KSwtKeycodeBit + 43,

    ESwtKeyKeypadSubtract = KSwtKeycodeBit + 45,

    ESwtKeyKeypadDecimal  = KSwtKeycodeBit + 46,

    ESwtKeyKeypadDivide   = KSwtKeycodeBit + 47,

    ESwtKeyKeypad0        = KSwtKeycodeBit + 48,

    ESwtKeyKeypad1        = KSwtKeycodeBit + 49,

    ESwtKeyKeypad2        = KSwtKeycodeBit + 50,

    ESwtKeyKeypad3        = KSwtKeycodeBit + 51,

    ESwtKeyKeypad4        = KSwtKeycodeBit + 52,

    ESwtKeyKeypad5        = KSwtKeycodeBit + 53,

    ESwtKeyKeypad6        = KSwtKeycodeBit + 54,

    ESwtKeyKeypad7        = KSwtKeycodeBit + 55,

    ESwtKeyKeypad8        = KSwtKeycodeBit + 56,

    ESwtKeyKeypad9        = KSwtKeycodeBit + 57,

    ESwtKeyKeypadEqual    = KSwtKeycodeBit + 61,

    ESwtKeyKeypadCR       = KSwtKeycodeBit + 80,

    ESwtKeyHelp           = KSwtKeycodeBit + 81,

    ESwtKeyCapsLock       = KSwtKeycodeBit + 82,

    ESwtKeyNumLock        = KSwtKeycodeBit + 83,

    ESwtKeyScrollLock     = KSwtKeycodeBit + 84,

    ESwtKeyPause          = KSwtKeycodeBit + 85,

    ESwtKeyBreak          = KSwtKeycodeBit + 86,

    ESwtKeyPrintScreen    = KSwtKeycodeBit + 87

};

/**

 * Structure containing the needed data for an SWT key event

 */

struct TSwtKeyEventData

{

    TSwtEventType iType;

    TChar         iCharacter;

    TInt          iKeyCode;

    TInt          iStateMask;

};

/**

 * SWT Line style

 */

enum TSwtLineStyle

{

    ESwtLineSolid      = 1, // Line drawing style for solid lines

    ESwtLineDash       = 2, // Line drawing style for dashed lines

    ESwtLineDot        = 3, // Line drawing style for dotted lines

    ESwtLineDashDot    = 4, // Line drawing style for alternating dash-dot lines

    ESwtLineDashDotDot = 5  // Line drawing style for dash-dot-dot lines

};

/*

 * Draw constants

 */

const TInt KSwtDrawTransparent = 1 << 0; // Indicates whether the drawing operation should fill the background.

const TInt KSwtDrawDelimiter   = 1 << 1; // Indicates whether the string drawing operation should handle line-delimeters.

const TInt KSwtDrawTab         = 1 << 2; // Indicates whether the string drawing operation should expand TAB characters.

const TInt KSwtDrawMnemonic    = 1 << 3; // Indicates whether the string drawing operation should handle mnemonics.

/**

 * SWT image type

 */

enum TSwtImageType

{

    ESwtImageBmp    = 0, // Indicates a Windows BMP format image.

    ESwtImageBmpRle = 1, // Indicates a run-length encoded Windows BMP format image.

    ESwtImageGif    = 2, // Indicates a GIF format image.

    ESwtImageIco    = 3, // Indicates a ICO format image.

    ESwtImageJpeg   = 4, // Indicates a JPEG format image.

    ESwtImagePng    = 5, // Indicates a PNG format image.

    ESwtImageTiff   = 6  // Indicates a TIFF format image.

};

enum TSwtImageLayoutType

{

    ESwtListImage = 1,

    ESwtChoiceImage,

    ESwtAlertImage

};

/**

 * GIF image disposal method

 */

enum TSwtGifDisposal

{

    KSwtDisposalUnspecified    = 0x0, // Indicates that the disposal method is unspecified.

    KSwtDisposalFillNone       = 0x1, // Indicates that the disposal method is to do nothing.

    KSwtDisposalFillBackground = 0x2, // Indicates that the previous images should be covered with the background colour before displaying the next image.

    KSwtDisposalFillPrevious   = 0x3  // Indicates that the disposal method is to restore the previous picture

};

/**

 */

enum TSwtColorId

{

    ESwtColorWidgetDarkShadow                = 17, // System colour used to paint dark shadow areas.

    ESwtColorWidgetNormalShadow              = 18, // System colour used to paint normal shadow areas.

    ESwtColorWidgetLightShadow               = 19, // System colour used to paint light shadow areas.

    ESwtColorWidgetHighlightShadow           = 20, // System colour used to paint highlight shadow areas.

    ESwtColorWidgetForeground                = 21, // System colour used to paint foreground areas.

    ESwtColorWidgetBackground                = 22, // System colour used to paint background areas.

    ESwtColorWidgetBorder                    = 23, // System colour used to paint border areas.

    ESwtColorListForeground                  = 24, // System colour used to paint list foreground areas.

    ESwtColorListBackground                  = 25, // System colour used to paint list background areas.

    ESwtColorListSelection                   = 26, // System colour used to paint list selection background areas.

    ESwtColorListSelectionText               = 27, // System colour used to paint list selected text.

    ESwtColorTitleForeground                 = 30, // System colour used to paint title text.

    ESwtColorTitleBackground                 = 31, // System colour used to paint title background areas.

    ESwtColorTitleBackgroundGradient         = 32, // System colour used to paint title background gradient.

    ESwtColorTitleInactiveForeground         = 33, // System colour used to paint inactive title text.

    ESwtColorTitleInactiveBackground         = 34, // System colour used to paint inactive title background areas.

    ESwtColorTitleInactiveBackgroundGradient = 35  // System colour used to paint inactive title background gradient.

};

/**

 */

/**

 * Window priorities. By default the CCoeControl window priority is 0.

 * The eSWT status pane must be always behind second level shells.

 * Second level shells must be always behind any other control.

 * ON_TOP second level shells must be always on top of any other

 * control and must never get faded inside the eSWT application.

 */

enum TSwtWinPriority

{

    ESwtWinPriorityInactiveTopShell = - 3,

    ESwtWinPriorityStatusPane = - 2,

    ESwtWinPriorityShell = -1,

    ESwtWinPriorityDefault = 0,

    ESwtWinPriorityMenu = 1

};

/**

 * Minimum distance between 2 lines of text. Used by Label and GC

 */

const TInt KSwtMinLinePadding = 1;

/**

 * Type of a pointer to a Java peer object

 */

typedef _jweak* TSwtPeer;

/**

 * Type of an array of Java peer objects

 */

typedef CArrayPtrFlat<_jweak> CSwtPeerArray;

/**

 * The window server events that the observer will receive.

 */

enum TSwtWsEvent

{

    SwtWsEventAppFocusGained,

    SwtWsEventAppFocusLost,

    SwtWsEventShutdown,

    SwtWsEventEndKeyPressed,

    SwtWsEventWindowVisibilityChanged,

    SwtWsEventUnknown

};

/**