os::FontRequester Class Reference
[The Syllable Graphical User Interface API]

Font Requester. More...

Inheritance diagram for os::FontRequester:

os::Window os::Looper os::Handler List of all members.

Public Member Functions

 FontRequester (Messenger *pcTarget=NULL, bool bEnableAdvanced=false)
 Constructor.
virtual ~FontRequester ()
void HandleMessage (Message *pcMessage)
 Handle a message targeted at this handler.
virtual bool OkToQuit (void)
 Check if it is ok to break the loop.

Detailed Description

Description:
The FontRequester is the default way to pick fonts in Syllable. The FontRequester is very easy to use. The following messages are sent to the given message target: M_FONT_REQUESTER_CANCELED - If the FontRequester is closed without any action. M_FONT_REQUESTED - If a Font has been selected to be loaded.
Note:
The FontRequester is sent an os::Messenger telling it where to send its messages to. If you send NULL to or use the default parameters, the FontRequester will send all messages to the instance of the application calling it.
Note:
The FontRequester is centered in the middle of the screen by default, you can override this at anytime after calling an instance of the dialog.
Example:
  FontRequester* pcFontRequester = new FontRequester(NULL,true); //enable shear/rotation
  pcFontRequester->Show();

  ...

  MyApplication::HandleMessage(Message* pcMessage)
  {
     switch (pcMessage->GetCode())
     {
        case M_FONT_REQUESTED:
        {
            os::Font* pcFont = new Font();
            pcMessage->FindObject("font",*pcFont);  //get the font from the requester and then do anything you want with it
            pcMyView->SetFont( pcFont );
            pcFont->Release();
            break;
        }
          
        case M_FONT_REQUESTER_CANCELED:
        {
            break; //do whatever you need to do when cancelled is called.
        }
     }
  }
See also:
os::Font, os::Message, os::Application, os::Window, os::FileRequester
Author:
Rick Caudill([email protected])


Constructor & Destructor Documentation

os::FontRequester::FontRequester ( Messenger pcTarget = NULL,
bool  bEnableAdvanced = false 
)

Description:
FontRequester constructor.
Parameters:
pcTarget - The target where all messages will be sent.
bEnableAdvanced - Determines whether or not Shear/Rotation will be enabled.
Author:
Rick Caudill ([email protected])

virtual os::FontRequester::~FontRequester (  )  [virtual]


Member Function Documentation

void os::FontRequester::HandleMessage ( Message pcMessage  )  [virtual]

Description:
Overload this member to dispatch messages sendt to this handler. When a looper receives a message for one of it's handlers it will call the taget handlers HandleMessage() to allow the handler to dispatch the message.
The message passed in pcMessage is also available through os::Looper::GetCurrentMessage() and os::Looper::DetachCurrentMessage() until this member returns. This is normally not very usefull for HandleMessage() itself but it can be convinient for other members called from HandleMessage() in case they need data from the message that was not passed on from HandleMessage().
The looper will be locked when this member is called. The default implementation of this member will pass the message on to the next handler if one was set with SetNextHandler().
Note:
Never do any lenthy operations in any hook members that are called from the looper thread if the looper is involved with the GUI (for example if the looper is a os::Window). The looper will not be able to dispatch messages until the hook returns so spending a long time in this members will make the GUI feel unresponsive.
Parameters:
pcMessage The message that should be handled. This message will be deleted by the looper when HandleMessage() returns unless you detach it with os::Looper::DetachCurrentMessage(),
See also:
os::Looper::DispatchMessage(), os::Looper::DetachCurrentMessage()
Author:
Kurt Skauen ([email protected])

Reimplemented from os::Handler.

virtual bool os::FontRequester::OkToQuit ( void   )  [virtual]

Description:
You can overload this function to affect how the looper will react to M_QUIT messages. When an M_QUIT message arrive the looper will call this function to figure out what to do. If it returns false the message is ignored. If it returns true the loop is terminated, the looper object deleted and the looper thread will exit.
Returns:
true if it is ok to terminate the looper, false otherwise.
See also:
Quit(), PostMessage()
Author:
Kurt Skauen ([email protected])

Reimplemented from os::Looper.


Generated on Sat May 9 22:51:27 2009 for Syllable higlevel API by  doxygen 1.5.1