/* **************************************************************************************
*  Copyright (c) 2004 ZORAN Corporation, All Rights Reserved
*  THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF ZORAN CORPORATION
*
*  File: $Workfile: o_hscroll_text_defs.h $
*
* Description:
* ============
* Project definition of the MSO_HSCROLL_TEXT object.
*
****************************************************************************************/
#ifndef _O_HSCROLL_TEXT_DEFS_H
#define _O_HSCROLL_TEXT_DEFS_H

/****************************************************************************************************
*	INCLUDE FILES: Only typedef header files are allowed to be included here.
****************************************************************************************************/
// Include C Standard

// Include project specific, only type definition header files are allowed to be included
#include "GUI\Object_class\Multiline\mso_multiline_text_defs.h"

/****************************************************************************************************
*	DEFINITION: Public named constants
****************************************************************************************************/
/****************************************************************************************************
*	 DEFINITION: Public macros
****************************************************************************************************/
/****************************************************************************************************
*	DEFINITION: Public typedefs
****************************************************************************************************/

typedef enum {
	HSCROLL_STATE_RESETTING,
	HSCROLL_STATE_SCROLLING_IN,
	HSCROLL_STATE_HOLDING,
	HSCROLL_STATE_SCROLLING_OUT,
	HSCROLL_STATE_SCROLL_DONE
} HSCROLL_STATE;

typedef enum {
	HSCROLL_START_LEFT,
	HSCROLL_START_RIGHT
} HSCROLL_START_POS;

enum {
	HSCROLL_REMOVE_IMMEDIATE,
	HSCROLL_REMOVE_SCROLL
};

enum {
	HSCROLL_SCROLL_INDIVIDUAL_TEXTS				= 0x10,
 	HSCROLL_SCROLL_CONTINUOUS					= 0x20,
	// Not implemented yet
       HSCROLL_SCROLL_FINISH_BEFORE_RESCROLL		= 0x40
};

typedef enum {
	HSCROLL_TYPE_FINISH_BEFORE_RESCROLL_REMOVE_SCROLL	= (HSCROLL_SCROLL_FINISH_BEFORE_RESCROLL |HSCROLL_REMOVE_SCROLL),
	HSCROLL_TYPE_FINISH_BEFORE_RESCROLL_REMOVE_IMMEDIATE	= (HSCROLL_SCROLL_FINISH_BEFORE_RESCROLL |HSCROLL_REMOVE_IMMEDIATE),
	HSCROLL_TYPE_CONTINUOUS_REMOVE_SCROLL					= (HSCROLL_SCROLL_CONTINUOUS |HSCROLL_REMOVE_SCROLL),
	HSCROLL_TYPE_CONTINUOUS_REMOVE_IMMEDIATE				= (HSCROLL_SCROLL_CONTINUOUS |HSCROLL_REMOVE_IMMEDIATE),
	HSCROLL_TYPE_INDIVIDUAL_TEXTS_REMOVE_SCROLL			= (HSCROLL_SCROLL_INDIVIDUAL_TEXTS |HSCROLL_REMOVE_SCROLL),
	HSCROLL_TYPE_INDIVIDUAL_TEXTS_REMOVE_IMMEDIATE		= (HSCROLL_SCROLL_INDIVIDUAL_TEXTS |HSCROLL_REMOVE_IMMEDIATE),
} HSCROLL_TYPE;

#define HSCROLL_REMOVE_MASK	0x0F
#define HSCROLL_SCROLL_MASK	0xF0

typedef struct {
	MS_DESCRIPTOR_MULTILINE_TEXT			moDescriptorMultilineText;
	HSCROLL_START_POS						meStartPos;
	HSCROLL_TYPE							meScrollType;
    	UINT8									mcPixelCount;
    	UINT8									mcHoldTime;
} MS_DESCRIPTOR_HSCROLL_TEXT;

typedef struct {
	UINT8									cCurrentState;
	INT16									iStartPixel;
	UINT8									mcHoldTimeRemaining;
	INT16									miBlockPixelLength;
} MS_PARAM_HSCROLL_TEXT;

typedef struct {
	MSO_MULTILINE_TEXT						moObject;
	MS_PARAM_HSCROLL_TEXT					moParam;
} MSO_HSCROLL_TEXT;

#endif // _O_HSCROLL_TEXT_DEFS_H