/* SPDX-License-Identifier: LGPL-2.1-only OR BSD-3-Clause */
/******************************************************************************
 *
 * This file is provided under a dual license.  When you use or
 * distribute this software, you may choose to be licensed under
 * version 2.1 of the GNU Lesser General Public License
 * ("LGPLv2.1 License") or BSD License.
 *
 * LGPLv2.1 License
 *
 * Copyright(C) 2019 MediaTek Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2.1 of the GNU Lesser General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html for more
 * details.
 *
 * BSD LICENSE
 *
 * Copyright(C) 2019 MediaTek Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/

/*-----------------------------------------------------------------------------
 * $RCSfile: x_wgl_tktp.h,v $
 * $Revision: #1 $
 * $Date: 2015/05/29 $
 * $Author: brianpc.huang $
 * $CCRevision: /main/DTV_X_HQ_int/1 $
 * $SWAuthor: TC Yin $
 * $MD5HEX: 2ae7da162fb3562b8d46f048422dd294 $
 *
 * Description: 
 *         This header file contains public interfaces, constant and type 
 *         definitions of the Widget Library.
 *---------------------------------------------------------------------------*/
 /*----------------------------------------------------------------------------*/
 /*! @defgroup groupMW_WGL_TKTP   Ticker Tape Widget
  *
  *  @ingroup groupMW_WGL
  *  @brief Provides definitions and exported function of the Ticker Tape widget.A Ticker Tape widget provides a way for applications to present a long text-based message in a constrained area of the OSD. The Ticker Tape widget presents the message by horizontally and smoothly scrolling the text. Besides, by optionally specifying some Ticker Tape widget styles, the message can be repeatedly scrolled around the viewport or stopped scrolling after one cycle. 
  *
  *  %MW Application API would be used by TV Application, lot of these APIs would
  *   be wrapped from Exported API
  *
  *  @see groupMW_WGL
  *  @{ 
  */
 /*----------------------------------------------------------------------------*/ 

#ifndef _X_WGL_TKTP_H_
#define _X_WGL_TKTP_H_

/*-----------------------------------------------------------------------------
                    include files
 ----------------------------------------------------------------------------*/
#include "u_wgl_tktp.h"

#ifdef __cplusplus
extern "C" {
#endif

/*-----------------------------------------------------------------------------
                    macros, defines, typedefs, enums
 ----------------------------------------------------------------------------*/
#define WGL_TKTP_INIT_CTRL_LOGIC            ((UINT32)0x00000001)/**< mask for tktp widget control logic init type */
#define WGL_TKTP_INIT_DEFAULT_CNT           ((UINT32)0x00000002)/**< mask for tktp widget default content init type */

/*-----------------------------------------------------------------------------
                    structures
 ----------------------------------------------------------------------------*/


/*-----------------------------------------------------------------------------
                    functions
 ----------------------------------------------------------------------------*/
 /*------------------------------------------------------------------*/
/*! @brief This function initialize tktp widget which is called when system initialize
 *  @param [in] ui4_init_type 	Specify widget init type
 *  @note
 *  @see
 *  @return  return error code
 *  @retval  WGLR_OK The routine was successful.
 *  @retval     WGLR_INV_ARG    ui4_init_type is not valid or the widget has been already initialized.
 *  @retval     WGLR_OUT_OF_MEMORY     memory resource is not enough.
 *  @retval      -
 */
/*------------------------------------------------------------------*/
extern INT32 x_wgl_tktp_init(UINT32 ui4_init_type);


#ifdef __cplusplus
}
#endif


#endif
/*----------------------------------------------------------------------------*/
/*! @} */   /* end of groupMW_WGL_TKTP*/
/*----------------------------------------------------------------------------*/


