//*****************************************************************************
//
//! Handles messages for an image button widget.
//!
//! \param psWidget is a pointer to the image button widget.
//! \param ui32Msg is the message.
//! \param ui32Param1 is the first parameter to the message.
//! \param ui32Param2 is the second parameter to the message.
//!
//! This function receives messages intended for this image button widget and
//! processes them accordingly. The processing of the message varies based on
//! the message in question.
//!
//! Unrecognized messages are handled by calling WidgetDefaultMsgProc().
//!
//! \return Returns a value appropriate to the supplied message.
//
//*****************************************************************************
int32_t
ImageButtonMsgProc(tWidget *psWidget, uint32_t ui32Msg,
uint32_t ui32Param1, uint32_t ui32Param2)
{
//
// Check the arguments.
//
ASSERT(psWidget);
//
// Determine which message is being sent.
//
switch(ui32Msg)
{
//
// The widget paint request has been sent.
//
case WIDGET_MSG_PAINT:
{
//
// Handle the widget paint request.
//
ImageButtonPaint(psWidget);
//
// Return one to indicate that the message was successfully
// processed.
//
return(1);
}
//
// One of the pointer requests has been sent.
//
case WIDGET_MSG_PTR_DOWN:
case WIDGET_MSG_PTR_MOVE:
case WIDGET_MSG_PTR_UP:
{
//
// Handle the pointer request, returning the appropriate value.
//
return(ImageButtonClick(psWidget, ui32Msg, ui32Param1,
ui32Param2));
}
//
// An unknown request has been sent.
//
default:
{
//
// Let the default message handler process this message.
//
return(WidgetDefaultMsgProc(psWidget, ui32Msg, ui32Param1,
ui32Param2));
}
}
}
//*****************************************************************************
//
//! Handles pointer events for a rectangular image button.
//!
//! \param pWidget is a pointer to the image button widget.
//! \param ulMsg is the pointer event message.
//! \param lX is the X coordinate of the pointer event.
//! \param lY is the Y coordinate of the pointer event.
//!
//! This function processes pointer event messages for a rectangular push
//! button. This is called in response to a \b #WIDGET_MSG_PTR_DOWN,
//! \b #WIDGET_MSG_PTR_MOVE, and \b #WIDGET_MSG_PTR_UP messages.
//!
//! If the \b #WIDGET_MSG_PTR_UP message is received with a position within the
//! extents of the image button, the image button's OnClick callback function is
//! called.
//!
//! \return Returns 1 if the coordinates are within the extents of the push
//! button and 0 otherwise.
//
//*****************************************************************************
static long
ImageButtonClick(tWidget *pWidget, unsigned long ulMsg, long lX, long lY)
{
tImageButtonWidget *pPush;
//
// Check the arguments.
//
ASSERT(pWidget);
//
// Convert the generic widget pointer into a image button widget pointer.
//
pPush = (tImageButtonWidget *)pWidget;
//
// See if this is a pointer up message.
//
if(ulMsg == WIDGET_MSG_PTR_UP)
{
//
// Indicate that this image button is no longer pressed.
//
pPush->ulStyle &= ~(IB_STYLE_PRESSED);
//
// Redraw the button in the released state.
//
ImageButtonPaint(pWidget);
//
// If the pointer is still within the button bounds, and it is a
// release notify button, call the notification function here.
//
if(GrRectContainsPoint(&pWidget->sPosition, lX, lY) &&
(pPush->ulStyle & IB_STYLE_RELEASE_NOTIFY) && pPush->pfnOnClick)
{
pPush->pfnOnClick(pWidget);
}
}
//
// See if the given coordinates are within the extents of the image button.
//
if(GrRectContainsPoint(&pWidget->sPosition, lX, lY))
{
//
// See if this is a pointer down message.
//
if(ulMsg == WIDGET_MSG_PTR_DOWN)
{
//
// Indicate that this image button is pressed.
//
pPush->ulStyle |= IB_STYLE_PRESSED;
//
// Draw the button in the pressed state.
//
ImageButtonPaint(pWidget);
}
//
// See if there is an OnClick callback for this widget.
//
if(pPush->pfnOnClick)
{
//
// If the pointer was just pressed then call the callback.
//
if((ulMsg == WIDGET_MSG_PTR_DOWN) &&
!(pPush->ulStyle & IB_STYLE_RELEASE_NOTIFY))
{
pPush->pfnOnClick(pWidget);
}
//
// See if auto-repeat is enabled for this widget.
//
if(pPush->ulStyle & IB_STYLE_AUTO_REPEAT)
{
//
// If the pointer was just pressed, reset the auto-repeat
// count.
//
if(ulMsg == WIDGET_MSG_PTR_DOWN)
{
pPush->ulAutoRepeatCount = 0;
}
//
// See if the pointer was moved.
//
else if(ulMsg == WIDGET_MSG_PTR_MOVE)
{
//
// Increment the auto-repeat count.
//
pPush->ulAutoRepeatCount++;
//
// If the auto-repeat count exceeds the auto-repeat delay,
// and it is a multiple of the auto-repeat rate, then
// call the callback.
//
if((pPush->ulAutoRepeatCount >=
pPush->usAutoRepeatDelay) &&
(((pPush->ulAutoRepeatCount -
pPush->usAutoRepeatDelay) %
pPush->usAutoRepeatRate) == 0))
{
pPush->pfnOnClick(pWidget);
}
}
}
}
//
// These coordinates are within the extents of the image button widget.
//
return(1);
}
//
// These coordinates are not within the extents of the image button widget.
//
return(0);
}
