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

 * 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 ESWTWIDGETSEXPANDED_H

#define ESWTWIDGETSEXPANDED_H

#include <eiklbi.h>

#include "eswt.h"

#include "eswtwidgetscore.h"

class MSwtListBase;

class MSwtColor;

class CSwtFontData;

class MSwtTable;

class CGraphicsContext;

class MSwtClipboard

{

protected:

    virtual ~MSwtClipboard() {}

public:

    /**

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

     * @return The Java peer associated with this object

     */

    virtual TSwtPeer Dispose() =0;

    /**

     * Clears the Clipboard.

     */

    virtual void ClearL() =0;

    /**

     * Gets the types of the data available in the Clipboard.

     * @param aTypes Upon call, this array must contain the data types to

     *        enquire about. Upon return, the non-available types will

     *        have been removed from it.

     */

    virtual void GetAvailableTypesL(RArray<TInt>& aTypes) const =0;

    /**

     * Returns the contents of the clipboard, as an array of bytes.

     * @param aTypeId Identifier of the expected type of the data

     *        contained in the clipboard.

     * @return the data, or NULL if no data of type aTypeId is found

     *        the clipboard.

     */

    virtual HBufC8* GetByteContentsL(TInt aDataId) const =0;

    /**

     * Returns the contents of the clipboard, as a text descriptor.

     * @return the text descriptor, or NULL if no text is found in the clipboard.

     */

    virtual HBufC* GetTextContentsL() const =0;

    /**

     * Set the content of the clipboard with a byte descriptor.

     * @param aPtr      The byte descriptor.

     * @param aJavaType The Java type identifier of the data.

     */

    virtual void SetByteContentL(const TDesC8& aPtr, TInt aJavaType) =0;

    /**

     * Set the content of the clipboard with a text descriptor.

     * @param aPtr The text descriptor.

     */

    virtual void SetTextContentL(const TDesC& aPtr) =0;

};

class MSwtTableColumn

{

protected:

    virtual ~MSwtTableColumn() {}

public:

    virtual TSwtPeer JavaPeer() const =0;

    /**

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

     */

    virtual TSwtPeer Dispose() =0;

    /**

     * Returns the alignment

     */

    virtual TInt Alignment() const =0;

    /**

     * Sets the column to its preferred size.

     */

    virtual void Pack() =0;

    /**

     * Sets the alignment of the column.

     */

    virtual void SetAlignment(TInt aAlignment) =0;

    /**

     * Sets the text of the column.

     */

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

    /**

     * Returns the text of the TableColumn

     *

     * @result A pointer ot the text. Cannot be null.

     */

    virtual const TDesC* GetText() const =0;

    /**

     * Sets the width of the column.

     */

    virtual void SetWidth(TInt aWidth) =0;

    /**

     * Returns the width of the column.

     */

    virtual TInt Width() const =0;

    /**

     * set the image of the TableColumn

     */

    virtual void SetColumnImage(const MSwtImage* aImage) =0;

    /**

     * Returns whether the column can be resized by the user

     */

    virtual TBool GetResizable() const = 0;

    /**

     * Sets the column's ability to be resized by the user

     */

    virtual void SetResizable(TBool aResizable) =0;

    /**

     * Returns this column's style flags

     */

    virtual TInt GetStyle() const =0;

};

class MSwtTableItem

{

protected:

    virtual ~MSwtTableItem() {}

public:

    /**

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

     */

    virtual TSwtPeer Dispose() =0;

    /**

     * Returns the background at the specified index.

     */

    virtual const MSwtColor* GetBackground(TInt aColumnIndex) const =0;

    /**

     * Returns the receiver's size and location relative to its parent

     * @param aColumnIndex  the column index

     */

    virtual TRect GetBounds(TInt aColumnIndex) const =0;

    /**

     * Returns the check state of the receiver.

     * If the Table was created without the CHECK style flag, this

     * method returns EFalse

     */

    virtual TBool GetChecked() const =0;

    /**

     * Returns the font used at the specified index.

     */

    virtual const MSwtFont* GetFont(TInt aColumnIndex) const =0;

    /**

     * Returns the foreground at the specified index.

     */

    virtual const MSwtColor* GetForeground(TInt aColumnIndex) const =0;

    /**

     * Returns the gray state.

     * If the Table was created without the CHECK style flag, this

     * method returns EFalse

     */

    virtual TBool GetGrayed() const =0;

    /**

     * Returns the  size and location of an image, relative to its parent

     * @param aColumnIndex  the column index

     */

    virtual TRect GetImageBounds(TInt aColumnIndex) const =0;

    /**

     * Returns the preferred width of the cell at index aColumnIndex,

     * depending on its font, image and checkbox.

     */

    virtual TSize GetPreferredSize(TInt aColumnIndex) const =0;

    /**

     * Returns the preferred width of the entire row,

     * depending on its font, image and checkbox.

     */

    virtual TSize GetPreferredSize() const =0;

    /**

     * Returns the text of the item, specified by its index.

     * @param aColumnIndex   the column index

     * @return The text, cannot be NULL.

     */

    virtual const TDesC* GetText(TInt aColumnIndex) const =0;

    /**

     * Insert a new column to the row.

     * No text or images is set. The font used is the default font.

     */

    virtual void InsertNewColumnL(TInt aColumnIndex) =0;

    /**

     * Remove a column from the row.

     */

    virtual void RemoveColumn(TInt aColumnIndex) =0;

    /**

     * Sets the background of the cell at index aColumnIndex.

     */

    virtual void SetBackground(TInt aColumnIndex, const MSwtColor* aColor) =0;

    /**

     * Sets the background for the entire row,

     */

    virtual void SetBackgroundForAll(const MSwtColor* aColor) =0;

    /**

     * Sets the font of the cell at index aColumnIndex.

     */

    virtual void SetFont(TInt aColumnIndex, const MSwtFont* aFont) =0;

    /**

     * Sets the font for the entire row.

     */

    virtual void SetFontForAll(const MSwtFont* aFont) =0;

    /**

     * Sets the foreground of the cell at index aColumnIndex,

     */

    virtual void SetForeground(TInt aColumnIndex, const MSwtColor* aColor) =0;

    /**

     * Sets the foreground for the entire row.

     */

    virtual void SetForegroundForAll(const MSwtColor* aColor) =0;

    /**

     * Sets the gray state.

     * If the Table was created without the CHECK style flag, this

     * method does nothing.

     */

    virtual void SetGrayed(TBool aIsGrayed) =0;

    /**

     * Sets an array of texts to the row.

     */

    virtual void SetTextArrayL(const CDesCArray* aTextArray) =0;

    /**

     * Sets the text to display at the specified index .

     */

    virtual void SetTextL(TInt aColumnIndex, const TDesC& aText) =0;

    /**

     * Sets an array of images to the row.

     */

    virtual void SetImageArray(const RPointerArray<MSwtImage>& aImages) =0;

    /**

     * Sets the image at the specified index.

     */

    virtual void SetImageByIndex(TInt aColumnIndex, const MSwtImage* aImage) =0;

    /**

     * Sets the check state of the receiver.

     */

    virtual void  SetChecked(TBool aChecked)=0;

    /**

     * Returns the Java Peer.

     */

    virtual TSwtPeer JavaPeer() const =0;

};

/**

 * Interface class for the org.eclipse.swt.widgets.Table class.

 */

class MSwtTable

{

protected:

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

public:

    /**

     * Returns the MSwtComposite interface

     */

    virtual MSwtComposite* Composite() =0;

    /**

     * Returns the TableItem array of the Table

     */

    virtual CSwtPeerArray* GetTableItemsL() =0;

    /**

     * Returns the TableColumn array of the Table

     */

    virtual CSwtPeerArray* GetTableColumnsL() =0;

    /**

     * Returns an array of TableItems that are currently

     * selected in the receiver.

     * Returned array is null if no item is selected.

     */

    virtual CSwtPeerArray* GetSelectionL() =0;

    /**

     * Register a TableItem

     * @param aChild the TableItem

     * @param aRowIndex where to add the TableItem

     */

    virtual void AddTableItemL(MSwtTableItem& aChild, TInt aRowIndex) =0;

    /**

     * Register a TableColumn

     * @param aChild the TableColumn

     * @param aColumnIndex where to add the TableColumn

     */

    virtual void AddTableColumnL(MSwtTableColumn& aChild, TInt aColumnIndex) =0;

    /**

     * Unregister a TableColumn

     * @param aChild the TableColumn

     */

    virtual void RemoveTableColumn(MSwtTableColumn& aChild) =0;

    /**

     * Returns the default font.

     */

    virtual const MSwtFont& DefaultFont() const =0;

    /**

     * Deselects the items defined in the aIndices array from the <a>Table</a>.

     * @param aIndices  The array of the items to deselect.

     * @param aCount   The number of items of this array.

     */

    virtual void DeselectItems(const TInt* aIndices, TInt aCount) =0;

    /**

     * Deselects the items indexed from aStart to aEnd from the <a>Table</a>.

     * @param aStart    The first element to deselect.

     * @param aEnd      The last element to deselect.

     */

    virtual void DeselectRange(TInt aStart, TInt aEnd) =0;

    /**

     * Searches the receiver's list starting at the first column (index 0)

     * until a column is found that is equal to the argument, and returns

     * the index of that column.

     * @param aColumn the TableColumn

     * @return the index of the Tablecolumn

     */

    virtual TInt IndexOfTableColumn(const MSwtTableColumn *aColumn) const =0;

    /**

     * Searches the receiver's list starting at the first item (index 0)

     * until an item is found that is equal to the argument, and returns

     * the index of that item.

     * @param aItem the TableItem

     * @return the TableItem

     */

    virtual TInt IndexOfTableItemAt(const MSwtTableItem *aItem, TInt aStart) const =0;

    virtual TInt IndexOfTableItem(const MSwtTableItem *aItem) const =0;

    /**

     * Returns the number of displayed columns in the Table.

     * A table with no TableColumn behaves as a List, displaying a dummy column

     * and therefore the method will return 1. To know the number of TableColumns

     * in the table, use GetTableColumnCount().

     * @return the number of columns in the table. Value is always strictly positive

     */

    virtual TInt GetColumnCount() const =0;

    /**

     * Returns the number of TableColumns in the Table.

     * A Table with no TableColumn will display a dummy column

     * and will behave as a list. GetTableColumnCount() will return 0 in that case.

     * To know how many columns are displayed, use GetColumnCount().

     * @return the number of TableColumn in the table.

     */

    virtual TInt GetTableColumnCount() const =0;

    /**

     * Returns ETrue if the receiver's header is visible, and EFalse otherwise.

     * the value is EFalse by default.

     * @return  ETrue if the header is visible.

     */

    virtual TBool GetHeaderVisible() const =0;

    /**

     * Returns ETrue if the item is selected, and EFalse otherwise.

     */

    virtual TBool   IsSelected(TInt aIndex) const =0;

    /**

     * Returns the column at the given, zero-relative index in the Table.

     */

    virtual TSwtPeer GetColumnL(TInt aIndex) const =0;

    /**

     * Returns a reference to the array of the alignments of the columns.

     */

    virtual const RArray<TInt>& GetColumnAlignments() const =0; // LeaveScan misreport

    /**

     * Returns a reference to the array of the widths of the columns.

     */

    virtual const RArray<TInt>& GetColumnWidths() const =0;

    /**

     * Returns a reference to the array of number of images of the columns.

     */

    virtual const RArray<TInt>& GetColumnImageCounts() const =0;

    /**

     * Returns the width in pixels of a grid line.

     */

    virtual TInt GetGridLineWidth() const =0;

    /**

     * Returns the height of the receiver's header

     */

    virtual TInt GetHeaderHeight() const =0;

    /**

     * Returns the item at the given, zero-relative index in the Table.

     * @param aIndex the index of the row

     * @return the item at the given, zero-relative index in the Table.

     */

    virtual TSwtPeer GetItemL(TInt aIndex) const =0;

    /**

     * Returns the number of items in the Table

     */

    virtual TInt GetItemCount() const =0;

    /**

     * Returns the rectangle of the specified TableItem, given an index in the Table.

     * @param aRowIndex the row index of the Table

     * @return the on-screen rectangle of the specified TableItem.

     */

    virtual TRect GetItemRect(TInt aRowIndex) const =0;

    /**

     * Returns ETrue if the receiver's lines are visible,

     * and EFalse otherwise. The default value is EFalse.

     */

    virtual TBool GetLinesVisible() const =0;

    /**

     * Gets the current selected item. return -1 if no item is selected.

     */

    virtual TInt GetSelectionIndex() const =0;

    /**

     * Returns the number of selected elements.

     */

    virtual TInt GetSelectionCount() const =0;

    /**

     * Returns the zero-relative index of the item which is currently

     * at the top of the receiver.

     */

    virtual TInt GetTopIndex() const =0;

    /**

     * Get the selected items indices.

     * @return  An array of indexes owned by the caller.

     */

    virtual const CArrayFix<TInt>* GetSelectionIndicesL() const =0;

    /**

     * Returns a reference to the image size used in the table.

     * The image size is the size of the first image added in the table

     * all other images in the table will use this size.

     * @return the image size used in the table.

     */

    virtual const TSize& ImageSize() const =0;

    /**

     * Notifies the Table that an image has been set in the specified column.

     * @param aColumnIndex the index of the column where an image has been added.

     */

    virtual void NotifyImageAdded(TInt aColumnIndex) =0;

    /**

     * Notifies the Table that an image has been removed in the specified column.

     * @param aColumnIndex the index of the column where an image has been removed.

     */

    virtual void NotifyImageRemoved(TInt aColumnIndex) =0;

    /**

     * Sets the column specified by index to its preferred size.

     * @param aColumnIndex the index of the Column to pack.

     */