Application

From Pointui

This is a Global object. You must not create an instance of it as one is always available for your use.

Provides access to application wide settings. NOTE: this is a global object so an instance is always available to use – you must not ever create additional instances.

Contents 1 Properties 1.1 Attributes (NameValueCollection) 1.2 BGImage (Surface) 2 Methods 2.1 void Close() 2.2 void FlagScreenChanged() 2.3 void Resized() 2.4 void AppGotFocus() 2.5 void AppLostFocus() 2.6 void SetBackground(String filename) 2.7 void PlayHelpScript(String filename) 2.8 void StopHelpScript() 2.9 void PauseHelpScript() 2.10 void ResumeHelpScript() 2.11 void SaveSettings() 2.12 String GetVersion() 2.13 bool GetIsFreeVersion() 2.14 int GetHwnd() 2.15 void SetTheme(String themeName) 2.16 void SetSoftKeyBarVisible(bool visible) 2.17 void SetHapticFeedbackEnabled(bool enabled)

Properties

Attributes (NameValueCollection)

Provides a generic bin for storing key/value pairs.

BGImage (Surface)

The image that is displayed as the background for screens.

Methods

void Close()

Exits Home.

void FlagScreenChanged()

Forces the screen to redraw. Typically the screen will know when it needs to redraw based on changes such as setting the text of a Label. However there is ever a need to force or ensure the screen updates then FlagScreenChanged can be used.

void Resized()

Called when the screen size changes.

void AppGotFocus()

Called when Home receives focus after having a different application previously showing.

void AppLostFocus()

Called when Home loses focus to another application which is being focused.

void SetBackground(String filename)

Sets the filename to use as the background image.

void PlayHelpScript(String filename)

Starts playing a help script.

void StopHelpScript()

Stops playing the current help script.

void PauseHelpScript()

Pauses the current script.

void ResumeHelpScript()

Resumes playback for the help script.

void SaveSettings()

Saves the name/values found in Attributes.

String GetVersion()

Returns the version of Home that is running.

bool GetIsFreeVersion()

Returns true if the version of Home running is the free version (as opposed to the purchased version which has extended functionality).

int GetHwnd()

Returns the HWND of the main application window.

void SetTheme(String themeName)

Sets the theme to use. A restart of the Home application is required for this to take effect. The themeName is not a full path – it should just be the name of the folder that the theme files are in (i.e. the folder name of theme under the AppletRibbon folder).

void SetSoftKeyBarVisible(bool visible)

Shows or hides the Soft Key Bar at the bottom of the screen within Home.

void SetHapticFeedbackEnabled(bool enabled)

Enables or disables haptic feedback within the application. NOTE: this is automatically called to apply the user's configuration settings, so calling this to force enabled/disabled will get the user settings out of sync with actual device behavior.