PrevNextUpHome SophiaFramework UNIVERSE 5.3
SFRMessageDialog
Responder which represents a dialog with at most 1 button.
#include <SFRMessageDialog.h.hpp>
class SFRMessageDialog : public SFRFrameDialog;
SFMTYPEDEFCLASS(SFRMessageDialog)

Inheritance diagram

Inheritance diagram of SFRMessageDialogClass

Collaboration diagram

Collaboration diagram of SFRMessageDialogClass

Description

SFRMessageDialog is a dialog with at most 1 button, i.e., the number of button is 1 or 0.

If the text of button is empty, the button will not be displayed.

The code to use a message dialog is as below: 

class ExampleAppli : public SFRApplication {
    ...
    
    // declaration of dialog handler
    HANDLER_DECLARE_VOIDDIALOG(OnDialog)
    
    ...
};

// implement of dialog handler
HANDLER_IMPLEMENT_VOIDDIALOG(ExampleAppli, OnDialog, result, dialog)
{
    
     ...  // some processing
 
    // close the dialog
    // dialog : Pointer to the dialog
    dialog->Invoke(SFXEvent(SREVT_RESPONDER_TERMINATE,
                     SRP16_TERMINATE_INVOKE, 
                            true));
}

// register the dialog handler
SFRDialogPtr dialog;
dialog = new SFRMessageDialog(SFXRectangle(20, 80, 200, 100),
                              "Process completed", 
                              "OK");

dialog->RegisterHandler(SREVT_DIALOG, 
                        HANDLER_BEFORE, 
                        HANDLER_FUNCTION(OnDialog));

Reference

SFRResponder | SFRApplication | SFRWindow | SFRDialog | SFRPlainDialog | SFRFrameDialog | SFRTitleDialog | SFRMultiDialog | Message Dialog

Member

Constructor/Destructor
SFRMessageDialog( SFXRectangleConstRef rectangle , SFXWideStringConstRef text , SFXWideStringConstRef ok , SFBImageSmpConstRef image = SFBImageSmp() , BehaviorType behavior = BEHAVIOR_SFRMESSAGEDIALOG , SFCType attribute = ATTRIBUTE_SFRMESSAGEDIALOG )
Constructor of the SFRMessageDialog class.
~SFRMessageDialog( Void )
Destructor of the SFRMessageDialog class.
Public Functions
Void SetBaseBound( SFXRectangleConstRef rect )
Set the base region with the coordinate of virtual region of parent responder.[This function is not available.]
Void SetVirtualBound( SFXRectangleConstRef rect )
Set the virtual region with the coordinate of content region.[This function is not available.]
Bool ClearHandler( Void ) (inherits from SFRResponder)
[Handler] Clear the " Targeted " status of responder, or destroy the responder.
Bool Compare( SFCType type , SFCType attribute , BehaviorType behavior ) (inherits from SFRResponder)
Compare with type, attribute and behavior.
Void DialogHandler( Void ) (inherits from SFRDialog)
[Handler] Close the dialog.
Bool FocusDown( Bool repeat = true ) (inherits from SFRResponder)
Focus down to the next responder.
Bool FocusDownHandler( Void ) (inherits from SFRResponder)
[Handler] Focus down to the next responder.
Bool FocusLeft( Bool repeat = true ) (inherits from SFRResponder)
Focus left to the next responder.
Bool FocusLeftHandler( Void ) (inherits from SFRResponder)
[Handler] Focus left to the next responder.
Bool FocusNext( Bool repeat = true ) (inherits from SFRResponder)
Focus to the next sibling responder.
Bool FocusNextHandler( Void ) (inherits from SFRResponder)
[Handler] Focus to the next sibling responder.
Bool FocusPrevious( Bool repeat = true ) (inherits from SFRResponder)
Focus to the previous sibling responder.
Bool FocusPreviousHandler( Void ) (inherits from SFRResponder)
[Handler] Focus to the previous sibling responder.
Bool FocusRight( Bool repeat = true ) (inherits from SFRResponder)
Focus right to the next responder.
Bool FocusRightHandler( Void ) (inherits from SFRResponder)
[Handler] Focus right to the next responder.
Bool FocusUp( Bool repeat = true ) (inherits from SFRResponder)
Focus up to the next responder.
Bool FocusUpHandler( Void ) (inherits from SFRResponder)
[Handler] Focus up to the next responder.
SFCType GetAttribute( Void ) (inherits from SFRResponder)
Get the attribute.
SFRResponderPtr GetBack( SFCType type = TYPE_WILDCARD , SFCType attribute = ATTRIBUTE_WILDCARD , BehaviorType compare = STATUS_VISIBLE|STATUS_ENABLE ) (inherits from SFRResponder)
Get the child responder at the most background that matches the specified search condition.
SFXRectangleConstRef GetBaseBound( Void ) (inherits from SFRResponder)
Get the base region with the coordinate of content region of parent responder.
SFXRectangle GetBaseWorld( Void ) (inherits from SFRResponder)
Get the base region.
SFXRGBColorConstRef GetColor( ColorType index ) (inherits from SFRFrameFrame)
Get the color.
SFXRectangleConstRef GetContentBound( Void ) (inherits from SFRResponder)
Get the content region with the coordinate of base region.
SFXRectangle GetContentWorld( Void ) (inherits from SFRResponder)
Get the content region.
SFRApplicationPtr GetDirector( Void ) (inherits from SFRWindow)
Get the parent responder.
SFRResponderPtr GetFocus( Void ) (inherits from SFRResponder)
Get the responder with focus in its ownership hierarchy.
SFXMargin GetFrameMargin( Void ) (inherits from SFRResponder)
Get the margin between base and content region(in pixels).
SFRResponderPtr GetFront( SFCType type = TYPE_WILDCARD , SFCType attribute = ATTRIBUTE_WILDCARD , BehaviorType compare = STATUS_VISIBLE | STATUS_ENABLE ) (inherits from SFRResponder)
Get the child responder at the most foreground that matches the specified search condition.
SInt16 GetIndexBackward( SFCType type = TYPE_WILDCARD , SFCType attribute = ATTRIBUTE_WILDCARD , BehaviorType compare = STATUS_VISIBLE|STATUS_ENABLE ) (inherits from SFRResponder)
Get the index number from the most background of responder that matches the specified search condition.
SInt16 GetIndexForward( SFCType type = TYPE_WILDCARD , SFCType attribute = ATTRIBUTE_WILDCARD , BehaviorType compare = STATUS_VISIBLE|STATUS_ENABLE ) (inherits from SFRResponder)
Get the index number from the most foreground of responder that matches the specified search condition.
Bool GetInheritEnable( Void ) (inherits from SFRResponder)
Get the " Enable / Disable " status of responder including its parent responders.
Bool GetInheritFocus( Void ) (inherits from SFRResponder)
Get the " Focused / Unfocused " status of responder including its parent responders.
Bool GetInheritTarget( Void ) (inherits from SFRResponder)
Get the " Target / Not-Target " status of responder including its parent responders.
Bool GetInheritVisible( Void ) (inherits from SFRResponder)
Get the " Visible / Invisible " status of responder including its parent responders.
SFRResponderPtr GetLeft( SFCType type = TYPE_WILDCARD , SFCType attribute = ATTRIBUTE_WILDCARD , BehaviorType compare = STATUS_VISIBLE|STATUS_ENABLE ) (inherits from SFRResponder)
Get the previous responder among the grouped responders that matches the specified search condition.
static
SFXMargin 		GetMargin( Void ) (inherits from SFRFrameFrame)
Get the margin between base and content region (in pixels).
SInt16 GetMoveInterval( Void ) (inherits from SFRResponder)
Get the move interval in pixels.
SInt16 GetMoveMargin( Void ) (inherits from SFRResponder)
Get the margin pixels of content region ( or virtual region if set with the parent responder ) where the child responder cannot move.
SFRResponderPtr GetNext( SFCType type = TYPE_WILDCARD , SFCType attribute = ATTRIBUTE_WILDCARD , BehaviorType compare = STATUS_VISIBLE|STATUS_ENABLE , Bool repeat = true ) (inherits from SFRResponder)
Get the next sibling responder that matches the specified search condition.
SFRResponderPtr GetNthBackward( SInt16 index , SFCType type = TYPE_WILDCARD , SFCType attribute = ATTRIBUTE_WILDCARD , BehaviorType compare = STATUS_VISIBLE|STATUS_ENABLE ) (inherits from SFRResponder)
Get the Nth child responder from the most background that matches the specified search condition.
SFRResponderPtr GetNthForward( SInt16 index , SFCType type = TYPE_WILDCARD , SFCType attribute = ATTRIBUTE_WILDCARD , BehaviorType compare = STATUS_VISIBLE|STATUS_ENABLE ) (inherits from SFRResponder)
Get the Nth child responder from the most foreground that matches the specified search condition.
SFRResponderPtr GetPrevious( SFCType type = TYPE_WILDCARD , SFCType attribute = ATTRIBUTE_WILDCARD , BehaviorType compare = STATUS_VISIBLE|STATUS_ENABLE , Bool repeat = true ) (inherits from SFRResponder)
Get the previous sibling responder that matches the specified search condition.
VoidPtr GetReference( Void ) (inherits from SFRResponder)
Get the reference value.
SFRResponderPtr GetRight( SFCType type = TYPE_WILDCARD , SFCType attribute = ATTRIBUTE_WILDCARD , BehaviorType compare = STATUS_VISIBLE|STATUS_ENABLE ) (inherits from SFRResponder)
Get the next responder among the grouped responders that matches the specified search condition.
SInt16 GetScrollInterval( Void ) (inherits from SFRResponder)
Get the scroll interval in pixels.
Bool GetStatusEnable( Void ) (inherits from SFRResponder)
Get the value of " Enable / Disable " flag.
Bool GetStatusFocus( Void ) (inherits from SFRResponder)
Get the value of " Focused / Unfocused " flag.
Bool GetStatusTarget( Void ) (inherits from SFRResponder)
Get the value of " Target / Non-target " flag.
Bool GetStatusVisible( Void ) (inherits from SFRResponder)
Get the value of " Visible / Invisible " flag.
SFXGrid GetTranslate( Void ) (inherits from SFRResponder)
Get the origin coordinate of virtual region with the coordinate of content region.
SInt16 GetTravelMargin( Void ) (inherits from SFRResponder)
Get the margin pixels of content region inside which the rectangle in the virtual region but outside the content region should be automatically scrolled by using the SFRResponder::Travel function.
SFCType GetType( Void ) (inherits from SFRResponder)
Get the responder type.
SFXRectangleConstRef GetVirtualBound( Void ) (inherits from SFRResponder)
Get the virtual region with the coordinate of content region.
SFXRectangle GetVirtualWorld( Void ) (inherits from SFRResponder)
Get the virtual region
Void Group( SFRResponderPtr with ) (inherits from SFRResponder)
Group the responder with the group of which representative responder is specified as an argument.
Void GroupMove( SFXSizeConstRef size ) (inherits from SFRResponder)
Move all the responders grouped together.
Void GroupScroll( SFXSizeConstRef size ) (inherits from SFRResponder)
Scroll all the virtual regions of responders grouped together.
Void GroupSelect( Void ) (inherits from SFRResponder)
Select all the responders grouped together. ( move all of them to the most foreground )
Void GroupStatusEnable( Bool enable ) (inherits from SFRResponder)
Set the " Enable / Disable " status of all the responders grouped together.
Void GroupStatusVisible( Bool visible ) (inherits from SFRResponder)
Set the " Visible / Invisible " status of all the responders grouped together.
Void InvalidateBase( Void ) (inherits from SFRResponder)
Register an area in the base region to be redrawn.
Void InvalidateBase( SFXRectangleConstRef rect ) (inherits from SFRResponder)
Register an area in the base region to be redrawn.
Void InvalidateContent( Void ) (inherits from SFRResponder)
Register an area in the content region to be redrawn.
Void InvalidateContent( SFXRectangleConstRef rect ) (inherits from SFRResponder)
Register an area in the content region to be redrawn.
Void InvalidateVirtual( Void ) (inherits from SFRResponder)
Register an area in the virtual region to be redrawn.
Void InvalidateVirtual( SFXRectangleConstRef rect ) (inherits from SFRResponder)
Register an area in the virtual region to be redrawn.
Bool Invoke( SFXEventConstRef event ) (inherits from SFRResponder)
Send the specified event.
Void Move( SFXSizeConstRef size ) (inherits from SFRResponder)
Move the responder.
Bool MoveDownHandler( Void ) (inherits from SFRResponder)
[Handler] Move the responder down.
Bool MoveLeftHandler( Void ) (inherits from SFRResponder)
[Handler] Move the responder left.
Bool MoveRightHandler( Void ) (inherits from SFRResponder)
[Handler] Move the responder right.
Bool MoveUpHandler( Void ) (inherits from SFRResponder)
[Handler] Move the responder up.
SFCError RegisterHandler( HandlerEnum timing , SFRHandlerSPP spp , VoidPtr ref ) (inherits from SFRHandler)
Register a handler.
SFCError RegisterHandler( SFCEventEnum type , HandlerEnum timing , SFRHandlerSPP spp , VoidPtr ref ) (inherits from SFRHandler)
Register a handler.
SFCError RegisterHandler( SFCEventEnum type , UInt16 p16 , HandlerEnum timing , SFRHandlerSPP spp , VoidPtr ref ) (inherits from SFRHandler)
Register a handler.
SFCError RegisterHandler( SFCEventEnum type , UInt16 bp16 , UInt16 ep16 , HandlerEnum timing , SFRHandlerSPP spp , VoidPtr ref ) (inherits from SFRHandler)
Register a handler.
SFCError RegisterHandler( SFCEventEnum btype , SFCEventEnum etype , HandlerEnum timing , SFRHandlerSPP spp , VoidPtr ref ) (inherits from SFRHandler)
Register a handler.
SFCError RegisterHandler( SFCEventEnum btype , SFCEventEnum endType , UInt16 p16 , HandlerEnum timing , SFRHandlerSPP spp , VoidPtr ref ) (inherits from SFRHandler)
Register a handler.
SFCError RegisterHandler( SFCEventEnum btype , SFCEventEnum etype , UInt16 bp16 , UInt16 ep16 , HandlerEnum timing , SFRHandlerSPP spp , VoidPtr ref ) (inherits from SFRHandler)
Register a handler.
SFCError RegisterTracer( BehaviorType behavior , TracerEnum trace ) (inherits from SFRTracer)
Register the tracer.
SFCError RegisterTracer( SFCEventEnum type , BehaviorType behavior , TracerEnum trace ) (inherits from SFRTracer)
Register the tracer.
SFCError RegisterTracer( SFCEventEnum type , UInt16 p16 , BehaviorType behavior , TracerEnum trace ) (inherits from SFRTracer)
Register the tracer.
SFCError RegisterTracer( SFCEventEnum type , UInt16 bgnP16 , UInt16 endP16 , BehaviorType behavior , TracerEnum trace ) (inherits from SFRTracer)
Register the tracer.
SFCError RegisterTracer( SFCEventEnum bgnType , SFCEventEnum endType , BehaviorType behavior , TracerEnum trace ) (inherits from SFRTracer)
Register the tracer.
SFCError RegisterTracer( SFCEventEnum bgnType , SFCEventEnum endType , UInt16 p16 , BehaviorType behavior , TracerEnum trace ) (inherits from SFRTracer)
Register the tracer.
SFCError RegisterTracer( SFCEventEnum bgnType , SFCEventEnum endType , UInt16 bgnP16 , UInt16 endP16 , BehaviorType behavior , TracerEnum trace ) (inherits from SFRTracer)
Register the tracer.
Void Scroll( SFXSizeConstRef size ) (inherits from SFRResponder)
Scroll the virtual region.
Bool ScrollDownHandler( Void ) (inherits from SFRResponder)
[Handler] Scroll the virtual region down.
Bool ScrollLeftHandler( Void ) (inherits from SFRResponder)
[Handler] Scroll the virtual region left.
Bool ScrollRightHandler( Void ) (inherits from SFRResponder)
[Handler] Scroll the virtual region right.
Bool ScrollUpHandler( Void ) (inherits from SFRResponder)
[Handler] Scroll the virtual region up.
Void Select( Void ) (inherits from SFRResponder)
Select the responder and move it to the most foreground.
Bool SelectHandler( Void ) (inherits from SFRResponder)
[Handler] Set the target status of a responder to true.
Void SetColor( ColorType index , SFXRGBColorConstRef color ) (inherits from SFRFrameFrame)
Set the color
Void SetContentBound( SFXRectangleConstRef rect ) (inherits from SFRFrameDialog)
Set the content region by the coordinate of base region. [This function is not available.]
Void SetFrameMargin( SFXMarginConstRef param ) (inherits from SFRResponder)
Set the margin between base and content region(in pixels).
Void SetMoveInterval( SInt16 interval ) (inherits from SFRResponder)
Set the move interval in pixels.
Void SetMoveMargin( SInt16 margin ) (inherits from SFRResponder)
Set the margin pixels of content region ( or virtual region if set with the parent responder ) where the child responder cannot move.
Void SetReference( VoidPtr ref ) (inherits from SFRResponder)
Set the reference value.
Void SetScrollInterval( SInt16 interval ) (inherits from SFRResponder)
Set the scroll interval in pixels.
Void SetStatusEnable( Bool enable ) (inherits from SFRResponder)
Set the value of " Enable / Disable " flag.
Void SetStatusFocus( Bool focus ) (inherits from SFRResponder)
Set the value of " Focused / Unfocused " flag.
Void SetStatusTarget( Bool target ) (inherits from SFRResponder)
Set the value of " Target / Not-Target " flag.
Void SetStatusVisible( Bool visible ) (inherits from SFRResponder)
Set the value of " Visible / Invisible " flag.
Void SetTranslate( SFXGridConstRef point ) (inherits from SFRResponder)
Set the origin coordinate of virtual region with the coordinate of content region.
Void SetTravelMargin( SInt16 margin ) (inherits from SFRResponder)
Set the margin pixels of content region inside which the rectangle in the virtual region but outside the content region should be automatically scrolled by using the SFRResponder::Travel function.
Void Travel( SFXRectangleConstRef rect ) (inherits from SFRResponder)
Scroll the virtual region of responder so that the specified rectangle can get into the content region.
Void Ungroup( Void ) (inherits from SFRResponder)
Ungroup the responders which are grouped together.
Void UnregisterHandler( HandlerEnum timing ) (inherits from SFRHandler)
Unregister the registered handler.
Void UnregisterHandler( SFCEventEnum type , HandlerEnum timing ) (inherits from SFRHandler)
Unregister the registered handler.
Void UnregisterHandler( SFCEventEnum type , UInt16 p16 , HandlerEnum timing ) (inherits from SFRHandler)
Unregister the registered handler.
Void UnregisterHandler( SFCEventEnum type , UInt16 bgnP16 , UInt16 endP16 , HandlerEnum timing ) (inherits from SFRHandler)
Unregister the registered handler.
Void UnregisterHandler( SFCEventEnum bgnType , SFCEventEnum endType , HandlerEnum timing ) (inherits from SFRHandler)
Unregister the registered handler.
Void UnregisterHandler( SFCEventEnum bgnType , SFCEventEnum endType , UInt16 p16 , HandlerEnum timing ) (inherits from SFRHandler)
Unregister the registered handler.
Void UnregisterHandler( SFCEventEnum bgnType , SFCEventEnum endType , UInt16 bgnP16 , UInt16 endP16 , HandlerEnum timing ) (inherits from SFRHandler)
Unregister the registered handler.
Void UnregisterTracer( Void ) (inherits from SFRTracer)
Unregister the tracer.
Void UnregisterTracer( SFCEventEnum type ) (inherits from SFRTracer)
Unregister the tracer.
Void UnregisterTracer( SFCEventEnum type , UInt16 p16 ) (inherits from SFRTracer)
Unregister the tracer.
Void UnregisterTracer( SFCEventEnum type , UInt16 bgnP16 , UInt16 endP16 ) (inherits from SFRTracer)
Unregister the tracer.
Void UnregisterTracer( SFCEventEnum bgnType , SFCEventEnum endType ) (inherits from SFRTracer)
Unregister the tracer.
Void UnregisterTracer( SFCEventEnum bgnType , SFCEventEnum endType , UInt16 p16 ) (inherits from SFRTracer)
Unregister the tracer.
Void UnregisterTracer( SFCEventEnum bgnType , SFCEventEnum endType , UInt16 bgnP16 , UInt16 endP16 ) (inherits from SFRTracer)
Unregister the tracer.
Protected Functions
static
SFXRectangle 		AdjustBound( SFXRectangleConstRef rect ) (inherits from SFRFrameFrame)
Adjust the coordinate of region.
SFXRectangle AdjustBound( SFXRectangleConstRef rect , AEEFont font ) (inherits from SFRTitleFrame)
Adjust the coordinate of region.
Void BaseHandler( SFXGraphicsPtr g ) (inherits from SFRFrameFrame)
[Handler] Redraw the base region of responder.
Void ContentHandler( SFXGraphicsPtr g ) (inherits from SFRFrame)
[Handler] Redraw the content region.
Void EscapeHandler( Void ) (inherits from SFRDialog)
[Handler] Close the dialog when the CLEAR key is pressed.
Bool GetAppearanceTransparent( Void ) (inherits from SFRResponder)
Get the value of APPEARANCE_TRANSPARENT flag.
Bool GetPropertyClosable( Void ) (inherits from SFRResponder)
Get the value of PROPERTY_CLOSABLE flag.
Bool GetPropertyDirect( Void ) (inherits from SFRResponder)
Get the value of PROPERTY_DIRECT flag.
Bool GetPropertyMovable( Void ) (inherits from SFRResponder)
Get the value of PROPERTY_MOVABLE flag.
Bool GetPropertyScrollable( Void ) (inherits from SFRResponder)
Get the value of PROPERTY_SCROLLABLE flag.
Bool GetPropertySelect( Void ) (inherits from SFRResponder)
Get the value of PROPERTY_SELECT flag.
Bool GetPropertyTravel( Void ) (inherits from SFRResponder)
Get the value of PROPERTY_TRAVEL flag.
SFRResponderPtr GetResponder( Void ) (inherits from SFRFrame)
Get the responder.
SFCError MakeHandler( Void ) (inherits from SFRFrameFrame)
Redraw the base region of responder.
HandlerRecConstPtr SearchHandler( SFXEventConstRef event , HandlerEnum timing ) (inherits from SFRHandler)
Search for the handler that matches the specified event.
TracerRecConstPtr SearchTracer( SFXEventConstRef event ) (inherits from SFRTracer)
Search for the tracer that matches the specified event.
Types
BehaviorEnum (inherits from SFRDialog)
Constant that represents the behavior of dialog.
ColorEnum (inherits from SFRFrameFrame)
Constant that represents a specific part.
HandlerEnum (inherits from SFRHandler)
Constant that represents the timing to call the handler.
SFRHandlerSPP (inherits from SFRHandler)
Type of the callback function.
TracerEnum (inherits from SFRTracer)
Constant that represents the trace order.
TracerTraceMPP (inherits from SFRTracer)
Type of the callback function.
SFRMessageDialog::SFRMessageDialog
Constructor of the SFRMessageDialog class.
[ public ]
SFRMessageDialog(
    SFXRectangleConstRef rectangle                      // the position of parent in coordinate
    SFXWideStringConstRef text                          // text to show
    SFXWideStringConstRef ok                            // button text
    SFBImageSmpConstRef image = SFBImageSmp()           // icon
    BehaviorType behavior = BEHAVIOR_SFRMESSAGEDIALOG   // behavior
    SFCType attribute = ATTRIBUTE_SFRMESSAGEDIALOG      // attribute
);

Instruction

If the button text is empty, the button will not be shown.

SFRMessageDialog::~SFRMessageDialog
Destructor of the SFRMessageDialog class.
[ public, virtual ]
~SFRMessageDialog(Void);

Reference

SFRDialog::~SFRDialog

SFRMessageDialog::SetBaseBound
Set the base region with the coordinate of virtual region of parent responder.[This function is not available.]
[ public, virtual ]
Void SetBaseBound(
    SFXRectangleConstRef rect   // value to set
);

Reference

SFRResponder::SetBaseBound

SFRMessageDialog::SetVirtualBound
Set the virtual region with the coordinate of content region.[This function is not available.]
[ public, virtual ]
Void SetVirtualBound(
    SFXRectangleConstRef rect   // value to set
);

Reference

SFRResponder::SetVirtualBound

Copyright(c) 2002 - 2024
Sophia Cradle Incorporated
All Rights Reserved. 		PrevNextUpHome