source/graphics/inc/mg_drawtext.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2008 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
 *******************************************************************************/
#ifndef _MG_DRAWTEXT_H
#define _MG_DRAWTEXT_H

#include "mg_osd.h"
#include "mg_fontapi.h"
#include "dtvstring.h"

#define FONT_STYLE_PLAIN      0x00
#define FONT_STYLE_SQUARE     0x10
#define FONT_STYLE_NO_SCALE   0x80

/* Justification */
#define JUSTIFY_H_START       0x00
#define JUSTIFY_H_END         0x01
#define JUSTIFY_H_CENTRE      0x02
#define JUSTIFY_H_JUSTIFIED   0x03
/* wrap words when reach line limit */
#define WRAP_WORDS            0x04
/* wrap on every character - vertical orientation*/
#define WRAP_VERTICAL         0x08

#define JFY_HZ_MASK           0x03
#define JFY_WRAP_MASK         0x0c
#define JFY_HZ_WRAP_MASK      0x0f

#define JUSTIFY_V_START     0x00
#define JUSTIFY_V_END       0x10
#define JUSTIFY_V_CENTRE    0x20
#define JUSTIFY_V_JUSTIFIED 0x30
#define JUSTIFY_VERTI_MASK  0x30

/* #define OBSCURE_INPUT       0x40 */

/* Characters used for Entryfield obscured input and cursor */
#define OBSCURED_INPUT_CHAR                 ('*')
#define ENTRY_INSERT_CHAR                   ('_')
#define ENTRY_OVERWRITE_CHAR                ('<')

#define HK_FNT_MAGIC       0xFEFF

typedef struct
{
   S16BIT left;
   S16BIT top;
   U16BIT width;
   U16BIT height;
} VRect, *pVRect;

/* 'TextString' is structure referencing unicode strings */
typedef struct _TextString
{
   U16BIT len;
   U16BIT *data;   /*unicode data*/
} TextString, *pTextString;

typedef struct _HyperAttribs
{
   /* hypertext specific colours - can be changed by "body attrib" in text*/
   OSDColor link_colour;
   OSDColor active_colour;
   OSDColor visit_colour;
   S16BIT focus_position;  /*zero when not interacting*/
   S16BIT number_of_links;  /*MG_drawText returns number of links found in text*/
   /*default below to zero*/
   U8BIT markup_state;
   U8BIT anchor_wrap;      /*MG_drawText returns with value (set by "body attrib" in text)*/
   U8BIT save_colour;      /*temp var*/
   /* U8BIT  interacting;   *not used*/
} HyperAttribs, *pHyperAttribs;

typedef struct s_FontProp
{
   S16BIT index;          /* value returned by MG_FontLoadFile() */
   U8BIT size;            /* vertical point size */
   U8BIT style;           /* plain/square */
} S_FontProp;

typedef struct _DrawTextAttrib
{
   pHyperAttribs p_ha;     /* Pointer to Hypertext attributes (default: NULL) */
   OSDColor fore_colour;
   OSDColor back_colour;
   U32BIT character_set;
   S16BIT entry_point;         /* position of 'caret' for Entryfield text box (default: -1) */
   S16BIT letter_space;        /* extra spacing between chars in 1/256 points */
   U16BIT caret;
   U8BIT line_space;           /* line spacing in points */
   U8BIT justify;              /* horz and vert and wrapping */
   union
   {
      H_FontSize hdl;
      S_FontProp fp;
   } font;
   S_STRING font_name;
} DrawTextAttrib, *pDrawTextAttrib;


void* MG_DrawText( const TextString unistr, pDrawTextAttrib attrib, const VRect txt_box );

S16BIT MG_TextWidth( const TextString unistr, pDrawTextAttrib attrib );

void MG_DrawScreenText( const TextString unistr, pDrawTextAttrib attrib, S_SURFACE *canvas );

#endif /*_MG_DRAWTEXT_H*/