MUISkin Class Reference

Generic skin management interface. More...

#include <MUISkin.h>

List of all members.

Public Types
enum	EFontType {   KButtonFont, KCheckBoxFont, KRadioButtonFont, KTitleFont,   KBigFont }
	Font types definitions. More...
enum	EImageType {   KDesktopBackground = 0, KCheckOn, KCheckOff, KCheckOnDisabled,   KCheckOffDisabled, KRadioOn, KRadioOff, KRadioOnDisabled,   KRadioOffDisabled, KSliderHorizontalEnabled, KSliderHorizontalDisabled, KSliderVerticalEnabled,   KSliderVerticalDisabled, KBlueLabyrinth, KRedLabyrinth, KGreenLabyrinth }
	Image types definition.
Public Member Functions
virtual MColorScheme *	GetColorScheme ()=0
	Returns the pointer to MColorScheme interface that represents current color scheme. Returned pointer should not be explicitly deleted by the application.
virtual MFont *	GetFont (EFontType aFontType)=0
	Returns the pointer to MFont interface that represents font with given type. Returned pointer should not be explicitly deleted by the application.
virtual MImage *	GetImage (EImageType aImageType)=0
	Returns the pointer to MImage interface that represents the image with given type.
virtual void	SetColorSchemeType (MColorScheme::EDefaultColorScheme aType)=0
	Sets the type of current color scheme After this call all the controls will redraw themselves using new color cheme. However, the screen is not redrawn automatically.
virtual MColorScheme::EDefaultColorScheme	GetColorSchemeType ()=0
	Returns the type of currently selected color scheme.
Static Public Member Functions
MUISkin *	GetCurrentSkin ()
	Returns the pointer to MUISkin interface that represents current skin. Returned pointer should not be explicitly deleted by the application.
void	SetCurrentSkin (MUISkin *aSkin)
	Deletes current skin and replaces it with a new given one.
void	SetDefaultSkinDirectory (const char *aDirectory)
const char *	GetDefaultSkinDirectory ()
	Returns the current default skin directory (without last /skin/ subdirectory).

---

Detailed Description

Generic skin management interface.

The skin is a set of parameters that determine the look and feel of the application. The application could use different skins to change its appearance on the fly. The skin is used by all widgets by default. However, there is a possibility to change the font, color scheme for every widget individually or for a given CUIScreen

For more information about default skin directory refer to SetDefaultSkinDirectory()

Default skin behaves in following way:

• Images for check boxes are read from following files:
  • CheckOn.bmp for checked image when the Check Box is enabled
  • CheckOff.bmp for unchecked image when the Check Box is enabled
  • CheckOnDis.bmp for checked image when the Check Box is disabled
  • CheckOffDis.bmp for unchecked image when the Check Box is disabled. Note that if one of files for disabled state does not exist, it is replaced by corresponding image for enabled state All pixels with pure red color (Red=255, Green=0, Blue=0) are treated as transparent and therefore not drawn

• Images for radio buttons are read from following files:
  • RadioOn.bmp for checked image when the radio button is enabled
  • RadioOff.bmp for unchecked image when the radio button is enabled
  • RadioOnDis.bmp for checked image when the radio button is disabled
  • RadioOffDis.bmp for unchecked image when the radio button is disabled. Note that if one of files for disabled state does not exist, it is replaced by corresponding image for enabled state All pixels with pure red color (Red=255, Green=0, Blue=0) are treated as transparent and therefore not drawn

• Images for sliders:
  • SliderHor.bmp for enabled horizontal slider image
  • SliderHorDis.bmp for disabled horizontal slider image
  • SliderVer.bmp for enabled vertical slider image
  • SliderVerDis.bmp for disabled vertical slider image Note that if one of files for disabled state does not exist, it is replaced by corresponding image for enabled state All pixels with pure red color (Red=255, Green=0, Blue=0) are treated as transparent and therefore not drawn

• Image for the background is read from Back.bmp file. If it does not exists, the background is a solid color returned by BackgroundColor() method of current color scheme.

• Different images for CUIScreen::MessageBox() are loaded from RedLabirinth.bmp, BlueLabirinth.bmp and GreenLabirinth.bmp

• Font definitions for buttons, controls and message boxes are read from ButtonFont.txt, ControlFont.txt and BigFont.txt files respectively. Those files all have the same format and consist from fields separated by spaces. First field represents font file name (without extension) and second field represents the font size. The extension is appended automatically and it is always .ttf. Refer to examples for more details. If one of those files does not exist, the default font name is Arial. The ControlFont.txt can have 3 additional optional fields that defines RGB components for the color controls like Check Boxes and Radio Buttons as are drawn with

---

Member Enumeration Documentation

enum MUISkin::EFontType

Font types definitions. Those font types are used by corresponding controls by default. However, there is a possibility to assign a different font type or event font to every MUIWidget. Enumeration values: KButtonFont  Font to draw normal buttons KCheckBoxFont  Font to draw check boxes KRadioButtonFont  Font to draw radio buttons KTitleFont  Font to draw labels and inputs KBigFont  Font to use in message boxes

---

Member Function Documentation

MUISkin* MUISkin::GetCurrentSkin (   )  [static]

Returns the pointer to MUISkin interface that represents current skin. Returned pointer should not be explicitly deleted by the application. Application should not permanently store the returned pointer because it could became invalid after the change of skin directory or new color scheme setup

virtual MImage* MUISkin::GetImage (  EImageType  aImageType  )  [pure virtual]

Returns the pointer to MImage interface that represents the image with given type. If aImageType parameter equals KBlueLabyrinth, KRedLabyrinth or KGreenLabyrinth, application should delete returned pointer. Otherwise êeturned pointer should not be explicitly deleted by the applicationþ

void MUISkin::SetCurrentSkin (  MUISkin *  aSkin  )  [static]

Deletes current skin and replaces it with a new given one. Parameters: aSkin  Pointer to new MUISkin interface. If NULL the default skin is re-initialised

void MUISkin::SetDefaultSkinDirectory (  const char *  aDirectory  )  [static]

Sets the directory for default skin Default skin stores all its data in separate .bmp, .txt and .ttf files. By default, default skin reads all its data from following locations: /mnt/sdcard/skin on real GO device ./skin on FLTK emulation Parameters: aDirectory  Path to an existing directory without /skin/ suffix.

---

The documentation for this class was generated from the following file:

• MUISkin.h

---