mh5button.c

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
 *******************************************************************************/
/*---includes for this file--------------------------------------------------*/
#include "mh5profile.h"
#include "mh5button.h"
#include "mh5object.h"          /* for actions      */
#include "mh5variable.h"        /* for actions      */
#include "mh5display.h"         /* for actions      */
#include "mh5application.h"     /* Default Colour   */
#include "mh5queue.h"           /* Events           */
#include "mh5debug.h"

#ifndef MHEG5PROFILE_UK1_06

#ifdef MH5PRINTOUT
#include <string.h>
#endif  /* #ifdef MH5PRINTOUT */

/*---constant definitions for this file--------------------------------------*/


/*---local typedef structs for this file-------------------------------------*/

/*---local (static) variable declarations for this file----------------------*/

/*---local function definitions----------------------------------------------*/

/*---global function definitions---------------------------------------------*/

/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5buttonPrint(MHEG5Button *button, char *out)
{
   MHEG5visiblePrint(&button->visible, out);
   MHEG5interactiblePrint(&button->interactible, out);
   MHEG5indent(out);
   MHEG_PRINT(out, ":RefColour ");
   MHEG5colourPrint(button->buttonColour, out);
   MHEG5newLine(out);
   MHEG5indent(out);
   MHEG_PRINT(out, "// SelectionStatus:\t");
   MHEG5boolPrint(button->selectionStatus, out);
   MHEG5newLine(out);
   MHEG5indent(out);
   MHEG_PRINT(out, "// CursorHere:\t");
   MHEG5boolPrint(button->cursorHere, out);
   MHEG5newLine(out);
}

#endif

void MHEG5buttonInit(MHEG5Button *button)
{
   assert(button);

   MHEG5visibleInit(&button->visible);
   MHEG5interactibleInit(&button->interactible);
}

void MHEG5buttonFree(MHEG5Button *button)
{
   assert(button);

   MHEG5visibleFree(&button->visible);
   MHEG5interactibleFree(&button->interactible);

   MHEG5genericDestruct(&button->buttonColour);
}

void MHEG5buttonPrepare(MHEG5Button *button)
{
   assert(button);
   MHEG5interactibleInitInternal(&button->interactible);
   button->selectionStatus = MHEG5FALSE;

   MHEG5visiblePrepare(&button->visible);
}

void MHEG5buttonActivate(MHEG5Button *button)
{
   assert(button);
   if (!button->visible.ingredient.root.availabilityStatus)
   {
      MHEG5buttonPrepare( button );
   }
   MHEG5visibleActivate(&button->visible);
}

void MHEG5buttonDeactivate(MHEG5Button *button)
{
   assert(button);

   MHEG5visibleDeactivate(&button->visible);

   /* Apply deactivation behaviour inherrited from Interactible class */
   MHEG5interactibleDeactivate(&button->interactible);
}

void MHEG5buttonDestruct(MHEG5Button *button)
{
   assert(button);

   MHEG5visibleDestruct(&button->visible);
   MHEG5interactibleDestruct(&button->interactible);
}

static void MHEG5buttonSelection(MHEG5Button *item)
{
   assert(item);

   item->selectionStatus = MHEG5TRUE;

   MHEG5displayRedraw((MHEG5Visible *)item);

   MHEG5sendSync((MHEG5Root *)item, MHEG5ISSELECTED, 0);
}

static void MHEG5buttonDeselection(MHEG5Button *item)
{
   assert(item);
   item->selectionStatus = MHEG5FALSE;

   MHEG5displayRedraw((MHEG5Visible *)item);

   MHEG5sendSync((MHEG5Root *)item, MHEG5ISDESELECTED, 0);
}

/*
     Actions
 */
MHEG5ErrorCode MHEG5select(MHEG5Root *target, MHEG5GList *params)
{
   assert(target);

   switch (target->clazz)
   {
      case MHEG5HOTSPOT:
      case MHEG5PUSHBUTTON:
         /* Execute the following sequence of actions:
          * 1. Apply the Selection behaviour as defined in the base class.
          */
         MHEG5buttonSelection((MHEG5Button *)target);

         /* 2. Apply the Deselection behaviour as defined in the base class. */
         MHEG5buttonDeselection((MHEG5Button *)target);
         break;

      case MHEG5SWITCHBUTTON:
         /* If the SelectionStatus attribute is True, disregard this action.
          * Otherwise, invoke the Selection behaviour.
          */
         if (((MHEG5Button *)target)->selectionStatus)
         {
            return MHEG5ERR_NOERROR;
         }
         MHEG5buttonSelection((MHEG5Button *)target);
         break;

      default:
         return MHEG5ERR_WRONGTARGET;
   }
   return MHEG5ERR_NOERROR;
}

MHEG5ErrorCode MHEG5deselect(MHEG5Root *target, MHEG5GList *params)
{
   assert( target );

   switch (target->clazz)
   {
      case MHEG5HOTSPOT:
      case MHEG5PUSHBUTTON:
      case MHEG5SWITCHBUTTON:
         /* If the SelectionStatus attribute is False, disregard this action.
          * Otherwise, invoke the Deselection behaviour.
          */
         if (!((MHEG5Button *)target)->selectionStatus)
         {
            return MHEG5ERR_NOERROR;
         }
         MHEG5buttonDeselection((MHEG5Button *)target);
         break;

      default:
         return MHEG5ERR_WRONGTARGET;
   }
   return MHEG5ERR_NOERROR;
}

#endif