X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=Usermode%2FApplications%2Faxwin3_src%2FWM%2Finclude%2Fwm.h;h=e060e246930d273160f70ee06dbe2ed9d1b003a4;hb=6a99a6d70179161964d47de9a825fd61e8445b86;hp=ad67f231c67501d2128d332fe47a017a24efb227;hpb=b1488ae9beae34068d38d00e191b90ef0bf812f3;p=tpg%2Facess2.git diff --git a/Usermode/Applications/axwin3_src/WM/include/wm.h b/Usermode/Applications/axwin3_src/WM/include/wm.h index ad67f231..e060e246 100644 --- a/Usermode/Applications/axwin3_src/WM/include/wm.h +++ b/Usermode/Applications/axwin3_src/WM/include/wm.h @@ -24,6 +24,8 @@ #define WINFLAG_NODECORATE 0x00000002 //! Window takes up all of screen #define WINFLAG_MAXIMIZED 0x00000004 +//! Window is contained within the parent +#define WINFLAG_RELATIVE 0x00000008 //! Window contents are valid #define WINFLAG_CLEAN 0x00000040 //! All child windows are un-changed @@ -45,20 +47,46 @@ typedef struct sIPC_Client tIPC_Client; // === FUNCTIONS === // --- Management extern tWindow *WM_CreateWindow(tWindow *Parent, tIPC_Client *Client, uint32_t ID, int Flags, const char *Renderer); +extern tWindow *WM_GetWindowByID(tWindow *Requester, uint32_t ID); extern void WM_Invalidate(tWindow *Window); extern void WM_SetWindowTitle(tWindow *Window, const char *Title); extern void WM_FocusWindow(tWindow *Destination); extern void WM_RaiseWindow(tWindow *Window); extern void WM_ShowWindow(tWindow *Window, int bShow); extern void WM_DecorateWindow(tWindow *Window, int bDecorate); +extern void WM_SetRelative(tWindow *Window, int bRelativeToParent); extern int WM_ResizeWindow(tWindow *Window, int W, int H); extern int WM_MoveWindow(tWindow *Window, int X, int Y); extern int WM_SendMessage(tWindow *Source, tWindow *Dest, int MessageID, int Length, const void *Data); // --- Rendering extern void WM_Render_FillRect(tWindow *Window, int X, int Y, int W, int H, tColour Colour); extern void WM_Render_DrawRect(tWindow *Window, int X, int Y, int W, int H, tColour Colour); -extern int WM_Render_DrawText(tWindow *Window, int X, int Y, int W, int H, tFont *Font, tColour Colour, const char *Text); -extern void WM_Render_GetTextDims(tFont *Font, const char *Text, int *W, int *H); +/** + * \brief Draw text to a window + * \param Window Destination Window + * \param X X coordinate (Left) + * \param Y Y coordinate (Top) + * \param W Width of destination region + * \param H Height of destination region + * \param Font Font to use + * \param Colour Text foreground colour + * \param Text UTF-8 string to render + * \param MaxLen Number of bytes in \a Text to read (Note: A final multi-byte sequence can exceed this count) + * + * \note As as noted in the \a MaxLen parameter, up to 3 more bytes may be read + * if the final character is a multi-byte UTF-8 sequence. This allows 1 + * to be passed to only render a single character. + */ +extern int WM_Render_DrawText(tWindow *Window, int X, int Y, int W, int H, tFont *Font, tColour Colour, const char *Text, int MaxLen); +/** + * \brief Get the dimensions of a string if it was rendered + * \param Font Font to use + * \param Text UTF-8 string to be processed + * \param MaxLen Number of bytes in \a Text to read (same caveat as WM_Render_DrawText applies) + * \param W Pointer to an integer to store the width of the rendered text + * \param H Pointer to an integer to store the height of the rendered text + */ +extern void WM_Render_GetTextDims(tFont *Font, const char *Text, int MaxLen, int *W, int *H); extern void WM_Render_DrawImage(tWindow *Window, int X, int Y, int W, int H, tImage *Image); extern void WM_Render_SetTextCursor(tWindow *Window, int X, int Y, int W, int H, tColour Colour); // NOTE: Should really be elsewhere