source/classes/inc/mh5text.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * 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
 *******************************************************************************/
#ifndef _MH5TEXT_H
#define _MH5TEXT_H

/*---includes for this file--------------------------------------------------*/
#include "mh5visible.h"

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

#define HJUSTIFICATION_START        (0)
#define HJUSTIFICATION_END          (1)
#define HJUSTIFICATION_CENTRE       (2)
#define HJUSTIFICATION_JUSTIFIED    (3)

#define VJUSTIFICATION_START        (0)
#define VJUSTIFICATION_END          (1)
#define VJUSTIFICATION_CENTRE       (2)
#define VJUSTIFICATION_JUSTIFIED    (3)

#define LINE_ORIENTATION_HORIZONTAL (MHEG5FALSE)
#define LINE_ORIENTATION_VERTICAL   (MHEG5TRUE)

#define BOM_NONE 0
#define BOM_LITTLE_ENDIAN 1
#define BOM_BIG_ENDIAN 2

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

/*---Global type defs for public use-----------------------------------------*/
typedef struct
{
   /* Base class */
   MHEG5Visible visible;

   /* Exchanged attributes */
   MHEG5FontBody originalFont;
   MHEG5String originalFontAttributes;
   MHEG5Colour originalTextColour;
   MHEG5Colour originalBackgroundColour;
   MHEG5Int characterSet;
   MHEG5Int horizontalJustification;
   MHEG5Int verticalJustification;
   MHEG5Bool verticalLineOrientation;
   MHEG5Int startCorner;
   MHEG5Bool textWrapping;

   /* Internal attributes */
   /* Text data internal attribute is stored in both raw format and adapted
    * (unicode) format. The raw format is stored in the textDataRaw attribute
    * of the Text class, the adapted format is stored in data attribute of the
    * Ingredient class. The two formats are stored to allow invalid UTF-8 data
    * to be loaded into a text object, then retrieved by a GetTextData action.
    *
    * Raw data is only stored for the Text and HyperText classes (not
    * EntryField since this can alter the TextData attribute through
    * interaction).
    */
   MHEG5String textDataRaw;
   MHEG5FontBody font;
   MHEG5String fontAttributes;
   MHEG5Colour textColour;
   MHEG5Colour backgroundColour;

   /*for engine use*/
   MHEG5Bool characterSetEncoded;
   MHEG5Int byteOrderMark;
} MHEG5Text;


/*---Global variable declarations for public use-----------------------------*/

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

void MHEG5textInit(MHEG5Text *text);


void MHEG5textFree(MHEG5Text *text);


MHEG5Text* MHEG5textClone(MHEG5Text *source);


/*
    Internal behaviours
 */
void MHEG5textPrepare(MHEG5Text *text);
void MHEG5textActivate(MHEG5Text *text);
void MHEG5textDeactivate(MHEG5Text *text);
void MHEG5textDestruct(MHEG5Text *text);


MHEG5ErrorCode MHEG5getTextData(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5getTextContent(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setFontAttributes(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setTextColour(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setBackgroundColour(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setFontRef(MHEG5Root *target, MHEG5GList *params);

void MHEG5textRedraw(MHEG5Text *text);

void MHEG5textUtf8Content(MHEG5Text *text, unsigned char *data, int len);

void MHEG5textUtf16Content(MHEG5Text *text, unsigned char *data, int len);

void MHEG5textContentUnadapt(MHEG5Text *text, MHEG5Byte **utf8Data,
   MHEG5Int *utf8Len);

void MHEG5textContentUnadaptUTF16(MHEG5Text *text, MHEG5Byte **utf16Data,
   MHEG5Int *utf16Len);
void MHEG5textClearTextData(MHEG5Text *text);


/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5textPrint(MHEG5Text *text, char *out);
#endif

#endif /*_MH5TEXT_H*/