mywindows.h

libminigui-1.3.0.tar.gz。 miniGUI的库函数源代码！

 * \return The handle to the tool tip window on success, HWND_INVALID on error.
 *
 * \sa resetToolTipWin, destroyToolTipWin
 */
HWND createToolTipWin (HWND hParentWnd, int x, int y, int timeout_ms,
                const char * text, ...);

/**
 * \fn void resetToolTipWin (HWND hwnd, int x, int y, const char* text, ...)
 * \brief Resets a tool tip window.
 *
 * This function resets the tool tip window specified by \a hwnd, including its
 * position, text displayed in it, and the visible status. If the tool tip is
 * invisible, it will become visible.
 *
 * This function also receives \a printf-like arguments to format a string. 
 *
 * Note that the tool tip window will disappear automatically after the specified 
 * milliseconds by \a timeout_ms if \a timeout_ms is larger than 9 ms.
 *
 * \param hwnd The tool tip window handle returned by \a createToolTipWin.
 * \param x x,y: The new position of the tool tip window.
 * \param y x,y: The new position of the tool tip window.
 * \param text The new format string.
 *
 * \sa createToolTipWin, destroyToolTipWin
 */
void resetToolTipWin (HWND hwnd, int x, int y, const char* text, ...);

/**
 * \fn void destroyToolTipWin (HWND hwnd)
 * \brief Destroies a tool tip window.
 *
 * This function destroies the specified tool tip window \a hwnd, which 
 * is returned by \a createToolTipWin.
 *
 * \param hwnd The handle to the tool tip window.
 * 
 * \sa createToolTipWin
 */
void destroyToolTipWin (HWND hwnd);

#ifdef _CTRL_PROGRESSBAR
/**
 * \fn HWND createProgressWin (HWND hParentWnd, char * title, char * label, int id, int range)
 * \brief Creates a main window within a progress bar.
 *
 * This function creates a main window within a progress bar and returns the handle.
 * You can call \a destroyProgressWin to destroy it. 
 *
 * Note that can use \a SendDlgItemMessage to send a message to the 
 * progress bar in the main window in order to update the progress bar.
 *
 * \param hParentWnd The hosting main window.
 * \param title The title of the progress window.
 * \param label The text in the label of the progress bar.
 * \param id The identifier of the progress bar.
 * \param range The maximal value of the progress bar (minimal value is 0).
 * \return The handle to the progress window on success, HWND_INVALID on error.
 *
 * \sa destroyProgressWin
 */
HWND createProgressWin (HWND hParentWnd, char * title, char * label,
        int id, int range);

/**
 * \fn void destroyProgressWin (HWND hwnd)
 * \brief Destroies progress window.
 *
 * This function destroies the specified progress window \a hwnd, which 
 * is returned by \a createProgressWin.
 *
 * \param hwnd The handle to the progress window.
 * 
 * \sa createToolTipWin
 */
void destroyProgressWin (HWND hwnd);
#endif

/**
 * Button info structure used by \a myWinMenu and \a myWinEntries function.
 * \sa myWinMenu, myWinEntries
 */
typedef struct _myWinButton
{
    /** text of the button. */
    char*   text;
    /** identifier of the button. */
    int     id;
    /** styles of the button. */
    DWORD   flags;
} myWINBUTTON;

/* This is an internal structure. */
typedef struct _myWinMenuItems
{
    /* the pointer to the array of the item strings. */
    char**      items;
    /* the identifier of the listbox display the menu items. */
    int         listboxid;
    /* the pointer to the array of the selection status of the items. */
    int*        selected;
    /* the minimal button identifier. */
    int         minbuttonid;
    /* the maximal button identifier. */
    int         maxbuttonid;
} myWINMENUITEMS;

/**
 * \fn int myWinMenu (HWND hParentWnd, const char* title, const char* label, int width, int listboxheight, char ** items, int * listItem, myWINBUTTON* buttons)
 * \brief Creates a menu main window for the user to select an item.
 *
 * This function creates a menu main window including a few buttons, 
 * and a list box with checkable item.
 * 
 * When the user click one of the buttons, this function will return the 
 * identifier of the button which leads to close the menu window, and 
 * the selections of the items via \a listItem.
 *
 * \param hParentWnd The hosting main window.
 * \param title The title of the menu main window.
 * \param label The label of the list box.
 * \param width The width of the menu main window.
 * \param listboxheight The height of the list box.
 * \param items The pointer to the array of the item strings.
 * \param listItem The pointer to the array of the check status of the items, initial and retured.
 * \param buttons The buttons will be created.
 * \return Returns the identifier of the button leading to close the menu window on success, else on errors.
 *
 * \sa myWINBUTTON
 */
int myWinMenu (HWND hParentWnd, const char* title, const char* label, 
                int width, int listboxheight, char ** items, int * listItem, 
                myWINBUTTON* buttons);

/**
 * Entry info structure used by \a myWinEntries function.
 * \sa myWinEntries
 */
typedef struct _myWinEntry
{
    /** the label of the entry. */
    char*   text;
    /** the pointer to the string of the entry. */
    char**  value;
    /** the maximal length of the entry in bytes. */
    int     maxlen;
    /** the styles of the entry. */
    DWORD   flags;
} myWINENTRY;

/* This is an internal structure. */
typedef struct _myWinEntryItems
{
    myWINENTRY* entries;
    int         entrycount;
    int         firstentryid;
    int         minbuttonid;
    int         maxbuttonid;
} myWINENTRYITEMS;

/**
 * \fn int myWinEntries (HWND hParentWnd, const char* title, const char* label, int width, int editboxwidth, BOOL fIME, myWINENTRY* items, myWINBUTTON* buttons)
 * \brief Creates a entry main window for the user to enter something.
 *
 * This function creates a entry main window including a few buttons
 * and a few entries.
 * 
 * When the user click one of the buttons, this function will return the 
 * identifier of the button which leads to close the menu window, and 
 * the entered strings.
 *
 * \param hParentWnd The hosting main window.
 * \param title The title of the menu main window.
 * \param label The label of the entries.
 * \param width The width of the menu main window.
 * \param editboxwidth The width of the edit boxes.
 * \param fIME Whether active the IME window.
 * \param items The pointer to the array of the entries, initial and returned.
 * \param buttons The buttons will be created.
 * \return Returns the identifier of the button leading to close the menu window on success, else on errors.
 *
 * \sa myWINBUTTON, myWINENTRY
 */
int myWinEntries (HWND hParentWnd, const char* title, const char* label,
                int width, int editboxwidth, BOOL fIME, myWINENTRY* items, 
                myWINBUTTON* buttons);

/**
 * \fn int myWinHelpMessage (HWND hwnd, int width, int height, const char* help_title, const char* help_msg)
 * \brief Creates a help message window.
 *
 * This function creates a help message window including a scrollable help message and a spin box.
 * When the user click the OK button, this function will return.
 *
 * \param hwnd The hosting main window.
 * \param width The width of the help message window.
 * \param height The height of the help message window.
 * \param help_title The title of the window.
 * \param help_msg The help message.
 * \return 0 on success, -1 on error.
 */
int myWinHelpMessage (HWND hwnd, int width, int height,
                const char* help_title, const char* help_msg);

    /** @} end of mywins_helpers */

    /** @} end of mywins_fns */

    /** @} end of mgext_fns */

#ifdef __cplusplus
}
#endif  /* __cplusplus */

#endif /* _MGUI_MYWINDOWS_H */