#include <SFBDisplay.h.hpp>

class SFBDisplay : public SFBBase;

SFMTYPEDEFWRAPPER(SFBDisplay)

[ public ]
Void Backlight(
    Bool on   // if true, the display backlights are turned on. 
              // if false, the display backlights are turned off
);

[ public ]
Void BitBlt(
    SInt32 xDest                    
    SInt32 yDest                    
    SInt32 cxDest                   
    SInt32 cyDest                   
    VoidConstPtr bmpSrc             
    SInt32 xSrc                     
    SInt32 ySrc                     
    AEERasterOp rop = AEE_RO_COPY   
);

[ public ]
Void BitBlt(
    SInt32 xDest                    
    SInt32 yDest                    
    SInt32 cxDest                   
    SInt32 cyDest                   
    SFXBufferConstRef bmpSrc        
    SInt32 xSrc                     
    SInt32 ySrc                     
    AEERasterOp rop = AEE_RO_COPY   
);

[ public ]
Void BitBlt(
    SFXRectangleConstRef rect       
    VoidConstPtr bmpSrc             
    SFXGridConstRef gridSrc         
    AEERasterOp rop = AEE_RO_COPY   
);

[ public ]
Void BitBlt(
    SFXRectangleConstRef rect       
    SFXBufferConstRef bmpSrc        
    SFXGridConstRef gridSrc         
    AEERasterOp rop = AEE_RO_COPY   
);

[ public ]
Void BitBlt(
    SFXRectangleConstRef rect       
    SFBBitmapSmpConstRef bmpSrc     
    SFXGridConstRef gridSrc         
    AEERasterOp rop = AEE_RO_COPY   
);

[ public ]
Void ClearScreen(Void);

[ public ]
SFCError Clone(
    SFBDisplaySmpPtr clone   // interface which will be filled with the address of the new instance
);

[ public ]
SFBDisplaySmp Clone(Void);

[ public ]
SFCError CreateDIBitmap(
    SFBDIBSmpPtr clone   // pointer to the new DIB Interface
    UInt08 depth         // number of bits used per pixel
    UInt16 width         // width in pixels of the new bitmap
    UInt16 height        // height in pixels of the new bitmap
);

[ public ]
SFBDIBSmp CreateDIBitmap(
    UInt08 depth           // number of bits used per pixel
    SFXSizeConstRef size   // size of the new bitmap
);

[ public ]
SInt32 DrawFrame(
    SFXRectanglePtr rect     // pointer to the source rectangle. 
                             // if this is null, this function just computes the adjustment value on each side based on the frame type and returns that value
    AEEFrameType frameType   // frame type
    RGBVAL fillType          // fill type for the inside of the frame
);

[ public ]
SInt32 DrawFrame(
    SFXRectanglePtr rect           // pointer to the source rectangle. 
                                   // if this is null, this function just computes the adjustment value on each side based on the frame type and returns that value
    AEEFrameType frameType         // frame type
    SFXRGBColorConstRef fillType   // fill type for the inside of the frame
);

[ public ]
Void DrawHLine(
    SInt16 x        // X coordinate of the starting point of the line
    SInt16 y        // Y coordinate of the starting point of the line
    SInt16 length   // length of the line
);

[ public ]
Void DrawHLine(
    SFXPixelConstRef pixel   // pixel of the starting point of the line
    SInt16 length            // length of the line
);

[ public ]
Void DrawRect(
    SFXRectangleConstRef rect   // pointer to a AEERect structure that defines the coordinates of the rectangle to be drawn. 
                                // these coordinates are in terms of destination bitmap coordinates with the left,
                                // top of the destination being (0,0)
    RGBVAL frameColor           // this specifies the color to be used for drawing the frame (outer borders) 
                                // of the rectangle. This parameter is used 
                                // only if dwFlags contains the flag IDF_RECT_FRAME
    RGBVAL fillColor            // this specifies the color to be used for filling the rectangle. 
                                // this parameter is used only if dwFlags contains the flag IDF_RECT_FILL
    UInt32 flags                // specifies the flags to be used for drawing the rectangle. 
                                // this can be a logical OR of one or more of the following flags:
                                // IDF_RECT_FRAME : Draw the outer borders of the rectangle only.
                                // IDF_RECT_FILL : Fill the rectangle with clrFill color. 
                                // IDF_RECT_INVERT: Invert the contents of the specified rectangle. 
                                // when this flag is set, clrFrame and clrFill parameters won't matter
);

[ public ]
Void DrawRect(
    SFXRectangleConstRef rect        
    SFXRGBColorConstRef frameColor   
    SFXRGBColorConstRef fillColor    
    UInt32 flags                     
);

[ public ]
SFCError DrawText(
    AEEFont font                    // specifies the font that needs to be used for drawing the text
    WCharConstPtr text              // contains the String that needs to be drawn
    SInt32 textLength               // specifies the number of characters in pcText. 
                                    // if this is -1, the length will be automatically computed by this function
    SInt32 x                        // specifies the left edge of the rectangle into which text will be drawn. 
                                    // this parameter is ignored when a horizontal alignment flag is set
    SInt32 y                        // specifies the top edge of the rectangle into which text will be drawn. 
                                    // this parameter is ignored when a vertical alignment flag is set
    SFXRectangleConstPtr rect       // specifies the coordinates of the clipping rectangle. 
                                    // if this is null, the boundries of the destination bitmap are taken as the clipping rectangle. 
                                    // no text is drawn outside this clipping rectangle. 
                                    // if any IDF_RECT_XXXX flag is specified, this rect is also used as filling, and so forth
                                    // note: This is distinct from the clipping rectangle set with SFBDisplay::SetClipRect.
                                    // the text is clipped to the intersection of these two clipping rectangles. 
                                    // IDF_ALIGN_XXXX flags align the text relative to the rectangle specified with prcBackground only
    UInt32 flags = IDF_ALIGN_NONE   // specifies the flags that can be used for drawing the text. 
                                    // this can be a logical OR of one of the items selected from each of the entries below: 
                                    // . One of the horizontal alignment flags (IDF_ALIGN_LEFT, IDF_ALIGN_CENTER,IDF_ALIGN_RIGHT)
                                    // . One of the vertical alignment flags (IDF_ALIGN_TOP, IDF_ALIGN_MIDDLE,IDF_ALIGN_BOTTOM)
                                    // . One of the text format flags (IDF_TEXT_UNDERLINE, IDF_TEXT_INVERTED, IDF_TEXT_DASHED_UNDERLINE)
                                    // . One of the rect format flags (IDF_RECT_FRAME,IDF_RECT_FILL,IDF_RECT_INVERT) 
                                    // these flags works on the prcBackground rectangle, using the CLR_USER_BACKGROUND as the fill color 
                                    // and CLR_USER_FRAME as the frame color. 
                                    // if no alignment flags are specified, the position of the text is determined by parameter x and y
);

[ public ]
SFCError DrawText(
    AEEFont font                    
    WCharConstPtr text              
    SInt32 textLength               
    SInt32 x                        
    SInt32 y                        
    SFXRectangleConstRef rect       
    UInt32 flags = IDF_ALIGN_NONE   
);

[ public ]
SFCError DrawText(
    AEEFont font                    // specifies the font that needs to be used for drawing the text
    SFXWideStringConstRef text      // contains the String that needs to be drawn
    SInt32 textLength               // specifies the number of characters in pcText. 
                                    // if this is -1, the length will be automatically computed by this function
    SFXGridConstPtr grid            // specifies the origin of the rectangle into which text will be drawn. 
    SFXRectangleConstPtr rect       // specifies the coordinates of the clipping rectangle. 
                                    // if this is null, the boundries of the destination bitmap are taken as the clipping rectangle. 
                                    // no text is drawn outside this clipping rectangle. 
                                    // if any IDF_RECT_XXXX flag is specified, this rect is also used as filling, and so forth
                                    // note: This is distinct from the clipping rectangle set with SFBDisplay::SetClipRect.
                                    // the text is clipped to the intersection of these two clipping rectangles. 
                                    // IDF_ALIGN_XXXX flags align the text relative to the rectangle specified with prcBackground only
    UInt32 align = IDF_ALIGN_NONE   // specifies the flags that can be used for drawing the text. 
                                    // this can be a logical OR of one of the items selected from each of the entries below: 
                                    // . One of the horizontal alignment flags (IDF_ALIGN_LEFT, IDF_ALIGN_CENTER,IDF_ALIGN_RIGHT)
                                    // . One of the vertical alignment flags (IDF_ALIGN_TOP, IDF_ALIGN_MIDDLE,IDF_ALIGN_BOTTOM)
                                    // . One of the text format flags (IDF_TEXT_UNDERLINE, IDF_TEXT_INVERTED, IDF_TEXT_DASHED_UNDERLINE)
                                    // . One of the rect format flags (IDF_RECT_FRAME,IDF_RECT_FILL,IDF_RECT_INVERT) 
                                    // these flags works on the prcBackground rectangle, using the CLR_USER_BACKGROUND as the fill color 
                                    // and CLR_USER_FRAME as the frame color. 
                                    // if the grid argument is set, the alignment flags will be ignored
);

[ public ]
SFCError DrawText(
    AEEFont font                    
    SFXWideStringConstRef text      
    SInt32 textLength               
    SFXGridConstRef grid            
    SFXRectangleConstRef rect       
    UInt32 align = IDF_ALIGN_NONE   
);

[ public ]
SFCError DrawText(
    AEEFont font                    
    SFXWideStringConstRef text      
    SInt32 textLength               
    SFXGridConstRef grid            
    UInt32 align = IDF_ALIGN_NONE   
);

[ public ]
SFCError DrawText(
    AEEFont font                    
    SFXWideStringConstRef text      
    SInt32 textLength               
    SFXRectangleConstRef rect       
    UInt32 align = IDF_ALIGN_NONE   
);

[ public ]
Void DrawVLine(
    SInt16 x        // X coordinate of the starting point of the line
    SInt16 y        // Y coordinate of the starting point of the line
    SInt16 length   // length of the line
);

[ public ]
Void DrawVLine(
    SFXPixelConstRef pixel   // plxel of the starting point of the line
    SInt16 length            // length of the line
);

[ public ]
Void EraseRect(
    SFXRectanglePtr rect   // a valid pointer to a rectangle to erase
);

[ public ]
Void EraseRgn(
    SInt16 x    // X coordinate of the top,left corner of the region
    SInt16 y    // Y coordinate of the top,left corner of the region
    UInt16 cx   // width of the region
    UInt16 cy   // height of the region
);

[ public ]
Void EraseRgn(
    SFXRectangleConstRef rect   // rectangle
);

[ public ]
Void FillRect(
    SFXRectanglePtr rect   // a valid pointer to a rectangle that needs to be filled with the specified color
    RGBVAL fillColor       // specifies the color to be used to fill the rectangle
);

[ public ]
Void FillRect(
    SFXRectanglePtr rect            // a valid pointer to a rectangle that needs to be filled with the specified color
    SFXRGBColorConstRef fillColor   // specifies the color to be used to fill the rectangle
);

[ public ]
Void FrameButton(
    SFXRectanglePtr rect   // pointer to the source rectangle
    Bool pressed           // button pressed/raised indicator
    RGBVAL fillType        // fill type for the inside of the frame 
);

[ public ]
Void FrameButton(
    SFXRectanglePtr rect           // pointer to the source rectangle
    Bool pressed                   // button pressed/raised indicator
    SFXRGBColorConstRef fillType   // color for the inside of the frame
);

[ public ]
Void FrameRect(
    SFXRectanglePtr rect   // a valid pointer to a rectangle whose borders need to be drawn
);

[ public ]
Void FrameSolidRect(
    SFXRectanglePtr rect   // a valid pointer to a rectangle that needs to be drawn and filled
);

[ public ]
Void GetClipRect(
    SFXRectanglePtr rect   // pointer to SFXRectangle to receive the current clip rectangle
);

[ public ]
SFXRectangle GetClipRect(Void);

[ public ]
SFBBitmapSmp GetDestination(Void);

[ public ]
SFCError GetDeviceBitmap(
    SFBBitmapSmpPtr clone   // pointer to interface for device bitmap
);

[ public ]
SFBBitmapSmp GetDeviceBitmap(Void);

[ public ]
SInt32 GetFontMetrics(
    AEEFont font               // specifies the font type for which the Ascent and Descent information is to be retrieved
    SInt32Ptr ascent = null    // this must be either null or a pointer to an SInt32. 
                               // on function return, the int specified (if any) will contain the Ascent value for the specified font. 
                               // if it is null, there will be a null returned ,too
    SInt32Ptr descent = null   // this must be either null or a pointer to an SInt32. 
                               // on function return, the int specified (if any) will contain the Ascent value for the specified font. 
                               // if it is null, there will be a null returned ,too
);

[ public, static ]
SFBDisplaySmp GetInstance(Void);

[ public ]
WChar GetSymbol(
    AEESymbol symbol   // requested symbol
    AEEFont font       // requested font
);

[ public ]
Void InvertRect(
    SFXRectanglePtr rect   // a valid pointer to a rectangle to be inverted
);

[ public ]
Bool IsEnabled(Void);

[ public ]
Void MakeDefault(Void);

[ public ]
SInt32 MeasureText(
    AEEFont font         // specifies the font that needs to be used for measuring the width of the given text. 
                         // measure the width of a given text if drawn using this font
    WCharConstPtr text   // pointer to a zero-terminated string to be measured
);

[ public ]
SInt32 MeasureText(
    AEEFont font                 // specifies the font that needs to be used for measuring the width of the given text. 
                                 // measure the width of a given text if drawn using this font
    SFXWideStringConstRef text   // pointer to a zero-terminated string to be measured
);

[ public ]
SInt32 MeasureTextEx(
    AEEFont font         
    WCharConstPtr text   
    SInt32 textLength    
    SInt32 maxWidth      
    SInt32Ptr fits       
);

[ public ]
SInt32 MeasureTextEx(
    AEEFont font                 
    SFXWideStringConstRef text   
    SInt32 textLength            
    SInt32 maxWidth              
    SInt32Ptr fits               
);

[ public, static ]
SFBDisplaySmp NewInstance(
    AEECLSID clsid = AEECLSID_DISPLAYCLONE   
);

[ public, static ]
SFBDisplaySmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBDisplaySmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

[ public ]
SFCError NotifyEnable(
    SFXCallbackPtr callback   // callback structure
);

[ public ]
Void ResetClipRect(Void);

[ public ]
SFCError ResetDestination(Void);

[ public ]
Void SetAnnunciators(
    UInt16 value   // the complete list of annunciators is:
                   // ANNUN_MMS To be used by MMS Applications
                   // ANNUN_MSG Voice mail 
                   // ANNUN_NET_MSG Net Message
                   // ANNUN_ALARMCLOCK Alarm Clock
                   // ANNUN_NET_LOCK Phone Locked
                   // ANNUN_STOPWATCH Stop Watch
                   // ANNUN_COUNTDOWN Count Down clock
                   // ANNUN_SILENCEALL Ringer Off
    UInt16 mask    // specifies that set of annunciators that this function is trying to enable or disable. 
                   // this is a logical OR of one or more of the annunciator flags defined above
);

[ public ]
Void SetClipRect(
    SFXRectangleConstRef rect   // the clipping rectangle to set
);

[ public ]
RGBVAL SetColor(
    AEEClrItem item    // specifies the color item whose color needs to be changed or retrieved
    RGBVAL itemColor   // specifies the new color to be associated with the item mentioned in "item" parameter
);

[ public ]
RGBVAL SetColor(
    AEEClrItem item                 // specifies the color item whose color needs to be changed or retrieved
    SFXRGBColorConstRef itemColor   // specifies the new color to be associated with the item mentioned in "item" parameter
);

[ public ]
SFCError SetDestination(
    SFBBitmapSmpConstRef bmpDest   // SFBBitmap interface pointer that will be used for rendering, or null to set to device (screen) bitmap
);

[ public ]
SFBFontPtr SetFont(
    AEEFont font         // the font designator
    SFBFontPtr newFont   // SFBFont pointer
);

[ public ]
SFCError SetPrefs(
    ACharConstPtr dispSettings   // Display settings string
    SInt32 dispSettingsLen       // Number of characters in dispSettings
);

[ public ]
SFCError SetPrefs(
    SFXAnsiStringConstRef dispSettings   // Display settings string
);

[ public ]
Void Update(Void);

[ public ]
Void UpdateEx(
    Bool defer   // boolean flag to indicate whether the screen needs to be updated immediately or deferred
);