Miscellaneous functions
[Global/general functions]

Defines

#define Draw3DControlFrame(hdc, l, t, r, b, fillc, updown)
Back compatibility definitions.
#define DrawFlatControlFrame(hdc, x0, y0, x1, y1, fillc, updown)
Back compatibility definitions.
#define Draw3DUpThickFrame(hdc, l, t, r, b, fillc) Draw3DThickFrameEx(hdc, HWND_DESKTOP, l, t, r, b, DF_3DBOX_NORMAL | ((fillc)?DF_3DBOX_FILL:0), fillc)
Back compatibility definitions.
#define Draw3DDownThickFrame(hdc, l, t, r, b, fillc) Draw3DThickFrameEx(hdc, HWND_DESKTOP, l, t, r, b, DF_3DBOX_PRESSED | ((fillc)?DF_3DBOX_FILL:0), fillc)
Back compatibility definitions.
#define Draw3DUpFrame Draw3DUpThickFrame
#define Draw3DDownFrame Draw3DDownThickFrame
#define Draw3DUpThinFrame(hdc, l, t, r, b, fillc) Draw3DThinFrameEx(hdc, HWND_DESKTOP, l, t, r, b, DF_3DBOX_NORMAL | ((fillc)?DF_3DBOX_FILL:0), fillc)
Back compatibility definitions.
#define Draw3DDownThinFrame(hdc, l, t, r, b, fillc) Draw3DThinFrameEx(hdc, HWND_DESKTOP, l, t, r, b, DF_3DBOX_PRESSED | ((fillc)?DF_3DBOX_FILL:0), fillc)
#define Draw3DBorder(hdc, l, t, r, b) Draw3DBorderEx(hdc, HWND_DESKTOP, l, t, r, b)
Back compatibility definitions.
#define NotifyParent(hwnd, id, code) NotifyParentEx(hwnd, id, code, 0)
Sends a notification message to the parent, but without additional data.
#define Beep Ping
Alias of Ping.

Typedefs

typedef int(* STRCMP )(const char *s1, const char *s2, size_t n)
Type of general strncmp function.

Enumerations

enum SBPolicyType { SB_POLICY_ALWAYS, SB_POLICY_AUTOMATIC, SB_POLICY_NEVER }
Scroll bar display policies in scrolled window. More...

Functions

MG_EXPORT void GUIAPI DrawBoxFromBitmap (HDC hdc, const RECT *box, const BITMAP *bmp, BOOL h_v, BOOL do_clip)
Draws a box from bitmap.
MG_EXPORT void GUIAPI Draw3DControlFrameEx (HDC hdc, HWND hwnd, int x0, int y0, int x1, int y1, DWORD flags, gal_pixel fillc)
Draws a 3D style frame control.
MG_EXPORT void GUIAPI DrawFlatControlFrameEx (HDC hdc, HWND hwnd, int x0, int y0, int x1, int y1, int corner, DWORD flags, gal_pixel fillc)
Draws a flat frame control with triangle corner.
MG_EXPORT void GUIAPI Draw3DThickFrameEx (HDC hdc, HWND hwnd, int l, int t, int r, int b, DWORD flags, gal_pixel fillc)
Draws a thick 3D frame.
MG_EXPORT void GUIAPI Draw3DThinFrameEx (HDC hdc, HWND hwnd, int l, int t, int r, int b, DWORD flags, gal_pixel fillc)
Draws a thin 3D frame.
MG_EXPORT void GUIAPI Draw3DBorderEx (HDC hdc, HWND hwnd, int l, int t, int r, int b)
Draws a 3D rectangle border.
MG_EXPORT void GUIAPI DisabledTextOutEx (HDC hdc, HWND hwnd, int x, int y, const char *szText)
Outputs disabled (grayed) text.
MG_EXPORT void GUIAPI NotifyParentEx (HWND hwnd, int id, int code, DWORD add_data)
Sends a notification message to the parent.
MG_EXPORT void GUIAPI Ping (void)
Makes a beep sound.
MG_EXPORT void GUIAPI Tone (int frequency_hz, int duration_ms)
Makes a tone.
MG_EXPORT void *GUIAPI GetOriginalTermIO (void)
Gets termios structure of the original terminal before initializing MiniGUI.

Define Documentation

#define Beep Ping

Alias of Ping.

See also:
Ping

Definition at line 2090 of file minigui.h.

#define Draw3DBorder ( hdc,
l,
t,
r,
b ) Draw3DBorderEx(hdc, HWND_DESKTOP, l, t, r, b)

Back compatibility definitions.

See also:
Draw3DBorderEx

Definition at line 266 of file ctrlhelper.h.

#define Draw3DControlFrame ( hdc,
l,
t,
r,
b,
fillc,
updown )

Value:
Draw3DControlFrameEx(hdc, HWND_DESKTOP, l, t, r, b, \ (updown?DF_3DBOX_NORMAL:DF_3DBOX_PRESSED) | ((fillc)?DF_3DBOX_FILL:0), fillc)
Back compatibility definitions.

See also:
Draw3DControlFrameEx

Definition at line 116 of file ctrlhelper.h.

#define Draw3DDownFrame Draw3DDownThickFrame

See also:
Draw3DUpThickFrame

Definition at line 202 of file ctrlhelper.h.

#define Draw3DDownThickFrame ( hdc,
l,
t,
r,
b,
fillc ) Draw3DThickFrameEx(hdc, HWND_DESKTOP, l, t, r, b, DF_3DBOX_PRESSED | ((fillc)?DF_3DBOX_FILL:0), fillc)

Back compatibility definitions.

See also:
Draw3DThickFrameEx

Definition at line 189 of file ctrlhelper.h.

#define Draw3DDownThinFrame ( hdc,
l,
t,
r,
b,
fillc ) Draw3DThinFrameEx(hdc, HWND_DESKTOP, l, t, r, b, DF_3DBOX_PRESSED | ((fillc)?DF_3DBOX_FILL:0), fillc)

See also:
Draw3DThinFrameEx

Definition at line 241 of file ctrlhelper.h.

#define Draw3DUpFrame Draw3DUpThickFrame

See also:
Draw3DUpThickFrame

Definition at line 196 of file ctrlhelper.h.

#define Draw3DUpThickFrame ( hdc,
l,
t,
r,
b,
fillc ) Draw3DThickFrameEx(hdc, HWND_DESKTOP, l, t, r, b, DF_3DBOX_NORMAL | ((fillc)?DF_3DBOX_FILL:0), fillc)

Back compatibility definitions.

See also:
Draw3DThickFrameEx

Definition at line 181 of file ctrlhelper.h.

#define Draw3DUpThinFrame ( hdc,
l,
t,
r,
b,
fillc ) Draw3DThinFrameEx(hdc, HWND_DESKTOP, l, t, r, b, DF_3DBOX_NORMAL | ((fillc)?DF_3DBOX_FILL:0), fillc)

Back compatibility definitions.

See also:
Draw3DThinFrameEx

Definition at line 234 of file ctrlhelper.h.

#define DrawFlatControlFrame ( hdc,
x0,
y0,
x1,
y1,
fillc,
updown )

Value:
DrawFlatControlFrameEx(hdc, HWND_DESKTOP, x0, y0, x1, y1, 3, \ (updown?DF_3DBOX_NORMAL:DF_3DBOX_PRESSED) | ((fillc)?DF_3DBOX_FILL:0), fillc)
Back compatibility definitions.

See also:
DrawFlatControlFrameEx

Definition at line 147 of file ctrlhelper.h.

#define NotifyParent ( hwnd,
id,
code ) NotifyParentEx(hwnd, id, code, 0)

Sends a notification message to the parent, but without additional data.

Parameters:

hwnd The handle to current control window.

id The identifier of current control.

code The notification code.

Note:
This function is actually a macro of NotifyParentEx with dwAddData being zero.

See also:
NotifiyParentEx

Definition at line 324 of file ctrlhelper.h.

Typedef Documentation

typedef int(* STRCMP)(const char *s1, const char *s2, size_t n)

Type of general strncmp function.
The function compares the two strings s1 and s2. It returns an integer less than, equal to, or greater than zero if s1 is found, respectively, to be less than, to match, or be greater than s2.
Note that it only compares the first (at most) n characters of s1 and s2.
Definition at line 337 of file ctrlhelper.h.

Enumeration Type Documentation

enum SBPolicyType

Scroll bar display policies in scrolled window.

Enumeration values:

SB_POLICY_ALWAYS The scroll bar is always visible

SB_POLICY_AUTOMATIC The scroll bar is shown or hided automatically

SB_POLICY_NEVER The scroll bar is never visbile

Definition at line 53 of file ctrlhelper.h.

Function Documentation

void GUIAPI DisabledTextOutEx ( HDC hdc,

HWND hwnd,

int x,

int y,

const char * szText

)

Outputs disabled (grayed) text.
This function outputs a grayed text at the specified position.

Parameters:

hdc The device context.

hwnd Tell the function to draw with the color definitions of this window.

x The x-coordinate of start point.

y The y-coordinate of start point.

szText The null-terminated text to be outputted.

See also:
TextOut, DrawText

void GUIAPI Draw3DBorderEx ( HDC hdc,

HWND hwnd,

int l,

int t,

int r,

int b

)

Draws a 3D rectangle border.
This function draws a 3D retangle border which is 2-pixel wide.

Parameters:

hdc The device context.

hwnd Tell the function to draw with the color definitions of this window.

l The x-coordinate of upper-left corner of the rectangle.

t The y-coordinate of upper-left corner of the rectangle.

r The x-coordinate of lower-right corner of the rectangle.

b The y-coordinate of lower-right corner of the rectangle.

See also:
Draw3DThinFrameEx, Draw3DThickFrameEx

void GUIAPI Draw3DControlFrameEx ( HDC hdc,

HWND hwnd,

int x0,

int y0,

int x1,

int y1,

DWORD flags,

gal_pixel fillc

)

Draws a 3D style frame control.

Parameters:

hdc The handle to drawing context.

hwnd Tell the function to draw with the color definitions of this window.

x0 Specify the x-coordinate of the upper-left corner.

y0 Specify the y-coordinate of the upper-left corner.

x1 Specify the x-coordinate of the lower-right corner.

y1 Specify the y-coordinate of the lower-right corner.

flags Specify the drawing flag, can be or'ed with the following flags:

DF_3DBOX_NORMAL
The box is displayed with normal status.
DF_3DBOX_PRESSED
The box is pressed.
DF_3DBOX_NOTFILL
Do not fill the box.
DF_3DBOX_FILL
Fill the box and the fillc defined the color.

fillc Specify the pixel value to fill the box when DF_3DBOX_FILL specified.

See also:
DrawFlatControlFrameEx

void GUIAPI Draw3DThickFrameEx ( HDC hdc,

HWND hwnd,

int l,

int t,

int r,

int b,

DWORD flags,

gal_pixel fillc

)

Draws a thick 3D frame.
This function draws a thin 3D frame (the border is 2-pixel wide), and fills the frame if a fill flag is specified.

Parameters:

hdc The device context.

hwnd Tell the function to draw with the color definitions of this window.

l The x-coordinate of upper-left corner of the frame.

t The y-coordinate of upper-left corner of the frame.

r The x-coordinate of lower-right corner of the frame.

b The y-coordinate of lower-right corner of the frame.

flags Specify the drawing flag, can be or'ed with the following flags:

DF_3DBOX_NORMAL
The box is displayed with normal status.
DF_3DBOX_PRESSED
The box is pressed.
DF_3DBOX_NOTFILL
Do not fill the box.
DF_3DBOX_FILL
Fill the box and the fillc defined the color.

fillc Specify the pixel value to fill the box when DF_3DBOX_FILL specified.

See also:
Draw3DControlFrameEx, DrawFlatControlFrameEx

void GUIAPI Draw3DThinFrameEx ( HDC hdc,

HWND hwnd,

int l,

int t,

int r,

int b,

DWORD flags,

gal_pixel fillc

)

Draws a thin 3D frame.
This function draws a thin 3D frame (the border is 1-pixel wide), and fills the frame if a fill flag is specified.

Parameters:

hdc The device context.

hwnd Tell the function to draw with the color definitions of this window.

l The x-coordinate of upper-left corner of the frame.

t The y-coordinate of upper-left corner of the frame.

r The x-coordinate of lower-right corner of the frame.

b The y-coordinate of lower-right corner of the frame.

flags Specify the drawing flag, can be or'ed with the following flags:

DF_3DBOX_NORMAL
The box is displayed with normal status.
DF_3DBOX_PRESSED
The box is pressed.
DF_3DBOX_NOTFILL
Do not fill the box.
DF_3DBOX_FILL
Fill the box and the fillc defined the color.

fillc Specify the pixel value to fill the box when DF_3DBOX_FILL specified.

See also:
Draw3DControlFrameEx, DrawFlatControlFrameEx

void GUIAPI DrawBoxFromBitmap ( HDC hdc,

const RECT * box,

const BITMAP * bmp,

BOOL h_v,

BOOL do_clip

)

Draws a box from bitmap.

Parameters:

hdc The handle to drawing context.

box The rectangle of the box.

bmp The pointer to the BITMAP object.

h_v Draw the box along horizental or vertical.

do_clip Does clip the drawing in the box?

void GUIAPI DrawFlatControlFrameEx ( HDC hdc,

HWND hwnd,

int x0,

int y0,

int x1,

int y1,

int corner,

DWORD flags,

gal_pixel fillc

)

Draws a flat frame control with triangle corner.

Parameters:

hdc The handle to drawing context.

hwnd Tell the function to draw with the color definitions of this window.

x0 Specifies the x-coordinate of the upper-left corner.

y0 Specifies the y-coordinate of the upper-left corner.

x1 Specifies the x-coordinate of the lower-right corner.

y1 Specifies the y-coordinate of the lower-right corner.

corner Specifies the length of the edge of the triangle corner.

flags Specify the drawing flag, can be or'ed with the following flags:

DF_3DBOX_NORMAL
The box is displayed with normal status.
DF_3DBOX_PRESSED
The box is pressed.
DF_3DBOX_NOTFILL
Do not fill the box.
DF_3DBOX_FILL
Fill the box and the fillc defined the color.

fillc Specify the pixel value to fill the box when DF_3DBOX_FILL specified.

See also:
Draw3DControlFrameEx

void *GUIAPI GetOriginalTermIO ( void )

Gets termios structure of the original terminal before initializing MiniGUI.

Returns:
The pointer to the original termios structure.

void GUIAPI NotifyParentEx ( HWND hwnd,

int id,

int code,

DWORD add_data

)

Sends a notification message to the parent.
By default, the notification from a control will be sent to its parent window within a MSG_COMMAND messsage.
Since version 1.2.6, MiniGUI defines the Nofication Callback Procedure for control. You can specify a callback function for a control by calling SetNotificationCallback to receive and handle the notification from the control.
If you have defined the Notificaton Callback Procedure for the control, calling NotifyParentEx will call the notification callback procedure, not send the notification message to the parent.

Parameters:

hwnd The handle to current control window.

id The identifier of current control.

code The notification code.

add_data The additional data of the notification.

See also:
SetNotificationCallback

void GUIAPI Ping ( void )

Makes a beep sound.

See also:
Beep

void GUIAPI Tone ( int frequency_hz,

int duration_ms

)

Makes a tone.
This function will return after the tone. Thus, your program will be blocked when the tone is being played.

Parameters:

frequency_hz The frequency of the tone in hertz.

duration_ms The duration of the tone in millisecond.

Bug:
When MiniGUI runs on X Window, the tone can not be played correctly.

See also:
Ping

Generated on Mon Jun 26 13:54:35 2006 for MiniGUI V1.6.9 API Reference by

1.4.2

Miscellaneous functions [Global/general functions]