style.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2013 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
// pre-processor mechanism so multiple inclusions don't cause compilation error
#ifndef _STYLE_H
#define _STYLE_H

#include "plugin.h"

//---Constant and macro definitions for public use-----------------------------


//---Enumerations for public use-----------------------------------------------

typedef enum
{
   INHERIT,
   STATIC,
   ABSOLUTE,
   FIXED,
   RELATIVE,
} E_POSITION;

typedef struct s_offset
{
   S16BIT left;
   S16BIT top;
} S_OFFSET;

typedef struct s_style_size
{
   U16BIT width;
   U16BIT height;
} S_STYLE_SIZE;


//---Global type defs for public use-------------------------------------------

typedef struct s_style
{
   S_OBJECT_DATA obj;
   E_POSITION position;
   S_HBBTV_RECT rect;
} S_STYLE;

//---Global Function prototypes for public use---------------------------------

S_STYLE* StyleCreate(NPP instance, char *style_str);
void StyleDestroy(S_STYLE *style);

//NPObject* StyleForObject(NPP instance, NPNVariable variable);
NPObject* StyleObjectForPlugin(NPP instance);
S_OFFSET ScreenOffsetForPlugin(NPP instance);
S_STYLE_SIZE SizeForPlugin(NPP instance);
void ScreenRectForPlugin(NPP instance, S_HBBTV_RECT *rect);

E_POSITION StylePosition(NPP instance, NPObject *style_obj);
S_OFFSET StyleOffset(NPP instance, NPObject *style_obj);
S_STYLE_SIZE StyleSize(NPP instance, NPObject *style_obj);
void StyleRect(NPP instance, NPObject *style_obj, S_HBBTV_RECT *rect);
void StyleSetRect(NPP instance, NPObject *style_obj, S_HBBTV_RECT *rect);
void StyleSetWidth(NPP instance, NPObject *style_obj, U16BIT width);
void StyleSetHeight(NPP instance, NPObject *style_obj, U16BIT height);
const char* StylePositionString(E_POSITION pos);

#endif /*_STYLE_H*/