Embedded Artists / DMBasicGUI

A basic graphics package for the LPC4088 Display Module.

Dependents:   lpc4088_displaymodule_demo_sphere sampleGUI sampleEmptyGUI lpc4088_displaymodule_fs_aid ... more

Fork of DMBasicGUI by EmbeddedArtists AB

Embed: (wiki syntax)

« Back to documentation index

AppSlideShow Class Reference
Public Member Functions

AppSlideShow Class Reference

An App example showing how to use the SlideShow engine. More...

#include <AppSlideShow.h>

Inherits App.

Public Member Functions

 AppSlideShow (const char *scriptFile, const char *pathPrefix=NULL, int xoff=0, int yoff=0)
 Create a new App based on the specified slideshow.
virtual bool setup ()
 Prepare the App before it is started.
virtual void runToCompletion ()
 Runs the App to completion.
virtual bool teardown ()
 Cleanup.
void addResource (Resources id, Resource *res)
 Specifies the resource to use.

Detailed Description

An App example showing how to use the SlideShow engine.

The purpose of this example is to show how the SlideShow class can be used.

Definition at line 32 of file AppSlideShow.h.

Constructor & Destructor Documentation

AppSlideShow ( const char *  scriptFile,
const char *  pathPrefix = NULL,
int  xoff = 0,
int  yoff = 0 
)

Create a new App based on the specified slideshow.

Parameters:
scriptFilepath and filename of the script to run
pathPrefixoptional path to prepend to all paths in the script file
xoptional x coordinate to draw the slideshow at, default is 0
yoptional y coordinate to draw the slideshow at, default is 0

Definition at line 60 of file AppSlideShow.cpp.

Member Function Documentation

void addResource ( Resources  id,
Resource *  res 
)

Specifies the resource to use.

Adds a resource for a specific id. This allows the user program to select e.g. which image to use and if it should be loaded from a file or an array.

Parameters:
idthe identifier
resthe resource

Definition at line 188 of file AppSlideShow.cpp.

void runToCompletion (  ) [virtual]

Runs the App to completion.

This function should not return until the App has finished.

Implements App.

Definition at line 106 of file AppSlideShow.cpp.

bool setup (  ) [virtual]

Prepare the App before it is started.

This function can be implemented to allocate memory, load startup images or other time consuming preparations.

The return value is to let the caller now if the application can be started or not.

Parameters:
xthe touched x coordinate
ythe touched y coordinate
pressedtrue if the user pressed the display
Returns:
true if the app can be started false if the setup failed

Reimplemented from App.

Definition at line 83 of file AppSlideShow.cpp.

bool teardown (  ) [virtual]

Cleanup.

Implement to free up the memory allocated in setup().

Returns:
true if the teardown finished successfully false if the teardown failed

Reimplemented from App.

Definition at line 162 of file AppSlideShow.cpp.

Generated on Tue Jul 12 2022 21:27:04 by  doxygen 1.7.2