ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / ART Component API Reference / ART Component Callback Functions Reference / LPFNIG_ART_MOUSENOTIFYFUNC
In This Topic
    LPFNIG_ART_MOUSENOTIFYFUNC
    In This Topic

    This callback, used during run-mode, is called when the end user interacts with marks using the mouse, including clicking on a mark or passing over one.

    Declaration:

     
    Copy Code
    typedef VOID (ACCUAPI *LPFNIG_ART_MOUSENOTIFYFUNC)(
            HIGEAR hIGear, 
            LPVOID lpPrivate, 
            ART_MARK_INDEX hMarkIndex, 
            AT_MODE nReason, 
            const LPAT_POINT lpPoint
    );
    

    Arguments:

    Name Type Description
    hIGear HIGEAR HIGEAR handle to the image.
    lpPrivate LPVOID A far pointer to the private callback data.
    hMarkIndex ART_MARK_INDEX The index number (identifier) for the new mark.
    nReason AT_MODE An ART-defined constant of type AT_MODE that determines why this callback has been called. See below.
    lpPoint const LPAT_POINT A far pointer structure of type AT_POINT that gives the screen coordinates of the position of the mouse at the time of the callback.

    Return Value:

    This callback function does not return a value.

    Supported Raster Image Formats:

    All pixel formats supported by ImageGear for C and C++.

    Sample:

    None

    Remarks:

    Here are the settings for nReason:

    ART_MOUSE_LBUTTON_DOWN Left button held down.
    ART_MOUSE_LBUTTON_DBL_CLICK Left button double-clicked.
    ART_MOUSE_LBUTTON_UP Left button up.
    ART_MOUSE_RBUTTON_DOWN Right button down.
    ART_MOUSE_RBUTTON_DBL_CLICK Right button double-clicked.
    ART_MOUSE_RBUTTON_UP Right button up.
    ART_MOUSE_ENTER The mouse cursor is entering a mark (i.e., the mouse moves over any visible portion of a mark).
    ART_MOUSE_LEAVE The mouse cursor is leaving a mark (i.e., the mouse was over a mark, then it moved, and is off the mark).

    This callback is called for each reason. You can put a switch statement into the callback function to respond or ignore each reason.

     

    In order to use this callback, it must be registered with ART using the function ART_callback_register().