MHEG5  22.3.0
Classes | Functions
mh5visible.h File Reference

Implement the MHEG5 Visible Class Defines the behaviour of Presentables that have a visual representation on the screen. Base class: Presentable Subclasses: Video, RTGraphics, Bitmap, LineArt, Text, Slider, Button Status: Abstract class. More...

#include "techtype.h"
#include "mh5ingredient.h"
#include "osdtypes.h"

Go to the source code of this file.

Classes

struct  MHEG5Visible
 

Functions

MHEG5Bool MHEG5visibleIs (MHEG5Root *target)
 <Function description>=""> More...
 
void MHEG5visibleInit (MHEG5Visible *visible)
 Initialise a visible object with default values. More...
 
void MHEG5visibleFree (MHEG5Visible *visible)
 Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed. More...
 
void MHEG5visibleClone (MHEG5Visible *destination, MHEG5Visible *source)
 Copy a visible object with original values. More...
 
void MHEG5visiblePrepare (MHEG5Visible *visible)
 Apply the preparation behaviour off the visible class Apply the preparation behaviour of the visible class. If the visible object is allready running, do nothing. Place the visible object to the top of the display stack. Apply the preparation behaviour of the ingredient class. More...
 
void MHEG5visibleActivate (MHEG5Visible *visible)
 Apply the activation behaviour of the visible class. Apply the activation behaviour off the visible class. More...
 
void MHEG5visibleDeactivate (MHEG5Visible *visible)
 Apply the deactivation behaviour of the visible class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class. More...
 
void MHEG5visibleDestruct (MHEG5Visible *visible)
 Destruct a visible object. More...
 
void MHEG5visibleResetPosition (MHEG5Visible *visible)
 Reset the position of the visible back to its original values (as stored in originalPosition). More...
 
void MHEG5visibleSetPosition (MHEG5Visible *visible, MHEG5Int x, MHEG5Int y)
 This procedure sets the position of the target visible object to the given values. More...
 
MHEG5ErrorCode MHEG5setPosition (MHEG5Root *target, MHEG5GList *params)
 Change the location of the target Visible. Implementation of the SetPosition (NewXPosition, NewYPosition) action of the visible class. More...
 
MHEG5ErrorCode MHEG5getPosition (MHEG5Root *target, MHEG5GList *params)
 Returns the location of the target Visible. More...
 
MHEG5ErrorCode MHEG5setBoxSize (MHEG5Root *target, MHEG5GList *params)
 Change the size of the bounding box of the target Visible. Implementation of the SetBoxSize (XNewBoxSize, YNewBoxSize) action of the visible class. More...
 
MHEG5ErrorCode MHEG5getBoxSize (MHEG5Root *target, MHEG5GList *params)
 Returns the size of the bounding box of the target Visible. Implementation of the GetBoxSize (XBoxSizeVar, YBoxSizeVar) action of the visible class. More...
 
MHEG5ErrorCode MHEG5bringToFront (MHEG5Root *target, MHEG5GList *params)
 Put a Visible at the foreground of the screen, i.e. on top of the Display Stack Implementation of the BringToFront action of the visible class. More...
 
MHEG5ErrorCode MHEG5sendToBack (MHEG5Root *target, MHEG5GList *params)
 Put a Visible at the background of the screen. Implementation of the SendToBack action of the visible class. More...
 
MHEG5ErrorCode MHEG5putBefore (MHEG5Root *target, MHEG5GList *params)
 Put a Visible exactly in front of another Visible in the display stack. Implementation of the PutBefore (ReferenceVisible) action of the visible class. More...
 
MHEG5ErrorCode MHEG5putBehind (MHEG5Root *target, MHEG5GList *params)
 Put a Visible exactly below another Visible in the display stack. Implementation of the PutBehind (ReferenceVisible) action of the visible class. More...
 
MHEG5ErrorCode MHEG5setPaletteRef (MHEG5Root *target, MHEG5GList *params)
 Change the colour look-up table used to render colours of the Visible object. Implementation of the SetPaletteRef(NewPaletteRef) action of the visible class. More...
 

Detailed Description

Implement the MHEG5 Visible Class Defines the behaviour of Presentables that have a visual representation on the screen. Base class: Presentable Subclasses: Video, RTGraphics, Bitmap, LineArt, Text, Slider, Button Status: Abstract class.

Date
29/04/2002
Author
iwillis

Function Documentation

MHEG5ErrorCode MHEG5bringToFront ( MHEG5Root *  target,
MHEG5GList *  params 
)

Put a Visible at the foreground of the screen, i.e. on top of the Display Stack Implementation of the BringToFront action of the visible class.

Parameters
MHEG5Root*target
MHEG5GList*params
Returns
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5getBoxSize ( MHEG5Root *  target,
MHEG5GList *  params 
)

Returns the size of the bounding box of the target Visible. Implementation of the GetBoxSize (XBoxSizeVar, YBoxSizeVar) action of the visible class.

Parameters
MHEG5Root*target
MHEG5GList*params
Returns
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5getPosition ( MHEG5Root *  target,
MHEG5GList *  params 
)

Returns the location of the target Visible.

Parameters
MHEG5Root*target
MHEG5GList*params
Returns
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5putBefore ( MHEG5Root *  target,
MHEG5GList *  params 
)

Put a Visible exactly in front of another Visible in the display stack. Implementation of the PutBefore (ReferenceVisible) action of the visible class.

Parameters
MHEG5Root*target
MHEG5GList*params
Returns
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5putBehind ( MHEG5Root *  target,
MHEG5GList *  params 
)

Put a Visible exactly below another Visible in the display stack. Implementation of the PutBehind (ReferenceVisible) action of the visible class.

Parameters
MHEG5Root*target
MHEG5GList*params
Returns
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5sendToBack ( MHEG5Root *  target,
MHEG5GList *  params 
)

Put a Visible at the background of the screen. Implementation of the SendToBack action of the visible class.

Parameters
MHEG5Root*target
MHEG5GList*params
Returns
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5setBoxSize ( MHEG5Root *  target,
MHEG5GList *  params 
)

Change the size of the bounding box of the target Visible. Implementation of the SetBoxSize (XNewBoxSize, YNewBoxSize) action of the visible class.

Parameters
MHEG5Root*target
MHEG5GList*params
Returns
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5setPaletteRef ( MHEG5Root *  target,
MHEG5GList *  params 
)

Change the colour look-up table used to render colours of the Visible object. Implementation of the SetPaletteRef(NewPaletteRef) action of the visible class.

Parameters
MHEG5Root*target
MHEG5GList*params
Returns
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5setPosition ( MHEG5Root *  target,
MHEG5GList *  params 
)

Change the location of the target Visible. Implementation of the SetPosition (NewXPosition, NewYPosition) action of the visible class.

Parameters
MHEG5Root*target
MHEG5GList*params
Returns
MHEG5ErrorCode MHEG5ErrorCode
void MHEG5visibleActivate ( MHEG5Visible *  visible)

Apply the activation behaviour of the visible class. Apply the activation behaviour off the visible class.

Parameters
MHEG5Visible*visible
Returns
void
void MHEG5visibleClone ( MHEG5Visible *  destination,
MHEG5Visible *  source 
)

Copy a visible object with original values.

Parameters
MHEG5Visible*destination
MHEG5Visible*source
Returns
void none
void MHEG5visibleDeactivate ( MHEG5Visible *  visible)

Apply the deactivation behaviour of the visible class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class.

Parameters
MHEG5Visible*visible
Returns
void
void MHEG5visibleDestruct ( MHEG5Visible *  visible)

Destruct a visible object.

Parameters
MHEG5Visible*visible
Returns
void
void MHEG5visibleFree ( MHEG5Visible *  visible)

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters
visiblePointer to object to free.
Returns
Void
void MHEG5visibleInit ( MHEG5Visible *  visible)

Initialise a visible object with default values.

Parameters
visiblePointer to object to initialise.
Returns
Void
MHEG5Bool MHEG5visibleIs ( MHEG5Root *  target)

<Function description>="">

Returns
<Return value>="">
<Return value>=""> Check if an object is of type Visible.
Parameters
MHEG5Root*target
Returns
MHEG5Bool MHEG5TRUE if the target Object is of type visible, otherwise the function returns MHEG5FALSE.
void MHEG5visiblePrepare ( MHEG5Visible *  visible)

Apply the preparation behaviour off the visible class Apply the preparation behaviour of the visible class. If the visible object is allready running, do nothing. Place the visible object to the top of the display stack. Apply the preparation behaviour of the ingredient class.

Parameters
MHEG5Visible*visible
Returns
void
void MHEG5visibleResetPosition ( MHEG5Visible *  visible)

Reset the position of the visible back to its original values (as stored in originalPosition).

Parameters
MHEG5Visible*visible
Returns
void
void MHEG5visibleSetPosition ( MHEG5Visible *  visible,
MHEG5Int  x,
MHEG5Int  y 
)

This procedure sets the position of the target visible object to the given values.

Parameters
MHEG5Visible*visible
MHEG5Intx
MHEG5Inty
Returns
void
Generated by   doxygen 1.8.11