Main Page | Modules | Class Hierarchy | Data Structures | File List | Data Fields | Globals | Related Pages

maiaButton Class Reference

#include <maiaButton.h>

Inheritance diagram for maiaButton:

omUIButton omObject

Public Member Functions

 maiaButton (wxWindow *, bool, maiaButtonData *)
void Show ()
void Clean ()
void Select ()
void Scan ()
void OnClick ()
void OnFocus ()
void PaintDefaultPicture ()
void LightOn ()
void LightOnSingle ()
void LightOff ()
void Execute ()
void SetCurrent ()
void ResetCurrent ()

Private Member Functions

void RenderPushButton ()
void SendSimulation ()

Private Attributes

int normalIndex
int selIndex
int scanIndex
 Figure index.

int scanSoundIndex
int selSoundIndex
 Sound index.

bool haveScanSound
bool haveSelSound
 Flag.

maiaButtonDatabuttonData
 Data associated with the button.

bool isCurrent
 Flag.


Detailed Description

This class extends omUIButton to add some functionalities and semplification. In particualr this button handles tree images used to store button figure in tree states:

This button handles two sounds:


Constructor & Destructor Documentation

maiaButton::maiaButton wxWindow *  parent,
bool  OnTop,
maiaButtonData data
 

The constructor. Initialize the MaiaButton adding images, sounds and other data.

Parameters:
*parent Window that contain this MaiaButton
OnTop If true put MaiaButton alwais on top.
data MaiaButtonData structure containing the data of the button


Member Function Documentation

void maiaButton::Clean  ) 
 

Clean button from any attributes. Paint 'normal' image.

void maiaButton::Execute  )  [virtual]
 

Implement the Execute method that is invoked by the automatic scan system to execute the code associated with the button. The method insert the execute code in the MaiaEventQueue structure of the application.

Reimplemented from omUIButton.

void maiaButton::LightOff  )  [virtual]
 

Implement the LightOff method that is invoked by the automatic scan system to turn of the scan mark. The function render the normal image on the button.

Reimplemented from omUIButton.

void maiaButton::LightOn  )  [virtual]
 

Implement the LightOn method that is invoked by the automatic scan system when the button is automatically scanned. The function render the scan image on the button.

Reimplemented from omUIButton.

void maiaButton::LightOnSingle  )  [virtual]
 

Implement the LightOnsingle method that is invoked by the automatic scan system when the button is automatically scanned. Check for soundEnabled option end play the sound if needed. The function render the scan image on the button.

Reimplemented from omUIButton.

void maiaButton::OnClick  )  [virtual]
 

Mouse click event. Implement MaiaLittleWindow virtual function. Automatically called when the button is clicked.

Reimplemented from omUIButton.

void maiaButton::OnFocus  )  [virtual]
 

Handle on focus event. When a button receive focus the focus is retured to the window that lost the focus.

Reimplemented from omUIButton.

void maiaButton::PaintDefaultPicture  )  [virtual]
 

Call the Clean() method to paint the default picture of the window

Reimplemented from omUIButton.

void maiaButton::RenderPushButton  )  [private]
 

This functions simulates the pressure of a button by rendering select image and after few milliseconds rendering last rendered image

void maiaButton::ResetCurrent  ) 
 

Reset current flag

void maiaButton::Scan  ) 
 

Set Scanned attribute to button. Paint 'scanned' image.

void maiaButton::Select  ) 
 

Set Select attribute to button. Paint 'selected' image.

void maiaButton::SendSimulation  )  [private]
 

This function send simulation to the event queue

void maiaButton::SetCurrent  ) 
 

Set current flag

void maiaButton::Show  ) 
 

Show the button and set the cursor on it if the button is selected by scan mode

Reimplemented from omUIButton.


Field Documentation

maiaButtonData* maiaButton::buttonData [private]
 

Data associated with the button.

bool maiaButton::haveScanSound [private]
 

bool maiaButton::haveSelSound [private]
 

Flag.

bool maiaButton::isCurrent [private]
 

Flag.

int maiaButton::normalIndex [private]
 

int maiaButton::scanIndex [private]
 

Figure index.

int maiaButton::scanSoundIndex [private]
 

int maiaButton::selIndex [private]
 

int maiaButton::selSoundIndex [private]
 

Sound index.


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