Mirrors_UI_SDK/MiniGUI
1
0
Fork 0
mirror of https://github.com/VincentWei/MiniGUI.git synced 2026-02-06 18:31:57 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

remove obsolete docs

Browse Source
This commit is contained in:
VincentWei
2018-05-08 22:56:08 +08:00
parent 990b9eabc9
commit bf69d0308a
61 changed files with 0 additions and 5834 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/html/.cvsignore
View File

@@ -1,3 +0,0 @@
*.css
*.png
*.html

0
doc/html/Makefile.am
View File

2
doc/man/Makefile.am
View File

@@ -1,2 +0,0 @@
SUBDIRS = man3 man5

1
doc/man/man3/.cvsignore
View File

@@ -1 +0,0 @@
*.3

249
doc/man/man3/Makefile.am
View File

@@ -1,249 +0,0 @@
EXTRA_DIST = \
about_dlg.3 \
accel_fns.3 \
_ARC.3 \
basic_types.3 \
_BITMAP.3 \
_BLOCKHEAP.3 \
block_heap_fns.3 \
bmp_fns.3 \
bmp_load_fns.3 \
bmp_struct.3 \
bug.3 \
caret_fns.3 \
_CHILDINFO.3 \
class_fns.3 \
clipboard_fns.3 \
clip_fns.3 \
_CLIPRECT.3 \
_CLIPRGN.3 \
color_vars.3 \
common.h.3 \
_CONTAINERINFO.3 \
control_fns.3 \
control.h.3 \
controls.3 \
_COOLBARITEMINFO.3 \
creation_msgs.3 \
ctrl_button.3 \
ctrl_button_msgs.3 \
ctrl_button_ncs.3 \
ctrl_button_states.3 \
ctrl_button_styles.3 \
ctrl_combobox.3 \
ctrl_combobox_msgs.3 \
ctrl_combobox_ncs.3 \
ctrl_combobox_styles.3 \
_CTRLDATA.3 \
ctrl_edit.3 \
ctrl_edit_msgs.3 \
ctrl_edit_ncs.3 \
ctrl_edit_styles.3 \
ctrl_listbox.3 \
ctrl_listbox_msgs.3 \
ctrl_listbox_ncs.3 \
ctrl_listbox_styles.3 \
ctrl_menubutton.3 \
ctrl_menubutton_msgs.3 \
ctrl_menubutton_ncs.3 \
ctrl_menubutton_styles.3 \
ctrl_msgs.3 \
ctrl_newtoolbar.3 \
ctrl_newtoolbar_msgs.3 \
ctrl_newtoolbar_styles.3 \
ctrl_progbar.3 \
ctrl_progbar_msgs.3 \
ctrl_progbar_ncs.3 \
ctrl_progbar_styles.3 \
ctrl_propsheet.3 \
ctrl_propsheet_msgs.3 \
ctrl_propsheet_ncs.3 \
ctrl_propsheet_styles.3 \
ctrl_scrollview.3 \
ctrl_scrollview_msgs.3 \
ctrl_scrollview_ncs.3 \
ctrl_scrollview_styles.3 \
ctrl_static.3 \
ctrl_static_msgs.3 \
ctrl_static_ncs.3 \
ctrl_static_styles.3 \
ctrl_textedit.3 \
ctrl_textedit_msgs.3 \
ctrl_textedit_ncs.3 \
ctrl_textedit_styles.3 \
ctrl_toolbar.3 \
ctrl_toolbar_msgs.3 \
ctrl_trackbar.3 \
ctrl_trackbar_msgs.3 \
ctrl_trackbar_ncs.3 \
ctrl_trackbar_styles.3 \
cursor_fns.3 \
dc_attrs.3 \
dc_fns.3 \
desktop_msgs.3 \
dialog_fns.3 \
_DLGTEMPLATE.3 \
draw_adv_2d_fns.3 \
draw_fns.3 \
endian_info.3 \
endian_rw_fns.3 \
endianrw.h.3 \
err_codes.3 \
etc_fns.3 \
_FILEDLGDATA.3 \
filedlg.h.3 \
fixed_math_fns.3 \
fixedmath.h.3 \
fixed_str.3 \
fns.3 \
font_fns.3 \
_FONTMETRICS.3 \
GAL_Color.3 \
GAL_Overlay.3 \
GAL_Palette.3 \
GAL_Rect.3 \
gamma_fns.3 \
gdi_fns.3 \
gdi.h.3 \
gdi_types.3 \
general_rw_fns.3 \
global_fns.3 \
global_vars.3 \
_GLYPHBITMAP.3 \
_GRIDCELL.3 \
_GRIDCOLHEADER.3 \
_GRIDNM_NORMAL.3 \
_GRIDROWHEADER.3 \
handles.3 \
_HOOKINFO.3 \
icon_fns.3 \
ime_fns.3 \
init_fns.3 \
key_defs.3 \
key_msgs.3 \
key_status.3 \
_LISTBOXITEMINFO.3 \
lite_fns.3 \
lite_layer_fns.3 \
lite_listenfd_fns.3 \
lite_request_fns.3 \
lite_server_fns.3 \
lite_socket_fns.3 \
lite_vars.3 \
_LOGFONT.3 \
_LVCOLUMN.3 \
_LVFINDINFO.3 \
_LVITEM.3 \
_LVNM_NORMAL.3 \
_LVSORTDATA.3 \
_LVSUBITEM.3 \
macros_types.3 \
_MAINWINCREATE.3 \
map_fns.3 \
_MCCOLORINFO.3 \
_MENUBUTTONITEM.3 \
menu_fns.3 \
_MENUITEMINFO.3 \
menu_msgs.3 \
MG_Client.3 \
mgext_control_grid_msgs.3 \
mgext_controls.3 \
mgext_ctrl_coolbar.3 \
mgext_ctrl_coolbar_msgs.3 \
mgext_ctrl_coolbar_styles.3 \
mgext_ctrl_grid.3 \
mgext_ctrl_grid_ncs.3 \
mgext_ctrl_listview.3 \
mgext_ctrl_listview_msgs.3 \
mgext_ctrl_listview_ncs.3 \
mgext_ctrl_listview_styles.3 \
mgext_ctrl_monthcal.3 \
mgext_ctrl_monthcal_msgs.3 \
mgext_ctrl_monthcal_ncs.3 \
mgext_ctrl_monthcal_styles.3 \
mgext_ctrl_spinbox.3 \
mgext_ctrl_spinbox_msgs.3 \
mgext_ctrl_spinbox_ncs.3 \
mgext_ctrl_spinbox_styles.3 \
mgext_ctrl_treeview.3 \
mgext_ctrl_treeview_msgs.3 \
mgext_ctrl_treeview_ncs.3 \
mgext_ctrl_treeview_styles.3 \
mgext_fns.3 \
mgext_gif_fns.3 \
mgext.h.3 \
mgext_skin_fns.3 \
MG_Layer.3 \
MG_RWops.3 \
minigui.h.3 \
misc_fns.3 \
misc_macros.3 \
mouse_msgs.3 \
_MSG.3 \
msgbox_fns.3 \
msg_fns.3 \
msg_hook_fns.3 \
msg_pass_fns.3 \
msgs.3 \
_MYBITMAP.3 \
_myWinButton.3 \
mywindows.h.3 \
_myWinEntry.3 \
mywins_filedlg.3 \
mywins_fns.3 \
mywins_helpers.3 \
_NTBINFO.3 \
_NTBITEMINFO.3 \
own_stdio.h.3 \
paint_msgs.3 \
pal_fns.3 \
_POINT.3 \
post_event_msgs.3 \
_RECT.3 \
rect_fns.3 \
rect_vars.3 \
region_fns.3 \
_REQUEST.3 \
_RGB.3 \
scrollbar_fns.3 \
_SCROLLINFO.3 \
_SCROLLVIEWITEMINFO.3 \
si_bmplabel_s.3 \
sie_slider_s.3 \
simple_types.3 \
si_nrmlabel_s.3 \
si_nrmslider_s.3 \
si_rotslider_s.3 \
_SIZE.3 \
skin.h.3 \
skin_head_s.3 \
skin_item_s.3 \
skin_set_s.3 \
_SPININFO.3 \
_STIPPLE.3 \
str_helpers.3 \
styles.3 \
_svitem_operations.3 \
sys_bmps.3 \
system_font.3 \
system_msgs.3 \
_SYSTEMTIME.3 \
sys_text.3 \
text_output_fns.3 \
text_parse_fns.3 \
timer_fns.3 \
_TOOLBARITEMINFO.3 \
_TVITEMINFO.3 \
user_msgs.3 \
vcongui_fns.3 \
vcongui.h.3 \
version_info.3 \
win32_types.3 \
window_create_fns.3 \
window_fns.3 \
window_general_fns.3 \
window.h.3 \
window_msgs.3 \
_WNDCLASS.3 \
_WORDINFO.3 \
yuv_fns.3

1
doc/man/man5/.cvsignore
View File

@@ -1 +0,0 @@
*.5

3
doc/man/man5/Makefile.am
View File

@@ -1,3 +0,0 @@
man_MANS=MiniGUI.cfg.5
EXTRA_DIST = $(man_MANS)

109
doc/man/man5/MiniGUI.cfg.5
View File

@@ -1,109 +0,0 @@
.TH MiniGUI.cfg 5 "August 2000" "libminigui" "MiniGUI User Documentation"
.SH NAME
MiniGUI.cfg \- The configuration file of MiniGUI.
.SH DESCRIPTION
.PP
In MiniGUI, you can get specific values from \fBetc\fP files using \fBGetValueFromEtcFile\fP and \fBGetIntValueFromEtcFile\fP. Etc files are text configuration files with same format as Windows INI files. A etc file has following simple format:
.PP
.nf
[section0]
key0=value0
key1=value1
[section1]
key0=value0
key1=value1
.fi
.PP
As you have seen, etc files are composed by \fBsections\fP. Every \fBvalue\fP in etc file is refrenced by \fBkey\fP. You should specify section name and key name to find a specific value.
.PP
MiniGUI uses a ETC file to store some system configuration data. This file is named MiniGUI.cfg. By default, this file will be installed in /etc directory. However, if there is a MiniGUI.cfg file in /usr/local/etc or in your home directory (saved as .MiniGUI.cfg), MiniGUI will use the latter MiniGUI.cfg file to get configuration data, so can override your system /etc/MiniGUI.cfg file.
.PP
This manpage describes the sections in MiniGUI.cfg file.
.SH "SECTIONS"
.SS
o system
.PP
\fBsystem\fP section defines system information of MiniGUI, including graphics engine, mouse type and mouse device. \fBengine\fP key specifies the graphics engine and \fBmdev\fP specifies the mouse device and \fBmtype\fP the mouse type.
.PP
If your graphics engine needs some other configuration data, these data will go into a section named by the engine name. For example, if your graphics engine is \fBSVGALib\fP, \fBSVGALib\fP section will define the configuration data for SVGALib.
.SS
o systemfont
.PP
\fBsystemfont\fP section defines system fonts for MiniGUI. \fBfont_number\fP key specifies the number of fonts, and \fBname?\fP key and \fBfontfile?\fP key define the font name and the path of the font file respectively. \fBname0\fP and \fBfontfile0\fP for the first font, \fBname1\fP and \fBfontfile1\fP for the second font, and so forth.
.PP
Generally, system fonts have identical size (height of font), but each belongs to a different charset. The first font should belong to a single-byte character charset.
.SS
o rawbitmapfonts
.PP
\fBrawbitmapfonts\fP section defines \fBRaw Bitmap Fonts\fP can be used by MiniGUI. The pattern of this section is similiar with \fBsystemfont\fP section.
.SS
o varbitmapfonts
.PP
\fBvarbitmapfonts\fP section defines \fBVar Bitmap Fonts\fP can be used by MiniGUI. The pattern of this section is similiar with \fBsystemfont\fP section.
.SS
o truetypefonts
.PP
\fBtruetypefonts\fP section defines \fBTrue Type Fonts\fP can be used by MiniGUI. The pattern of this section is similiar with \fBsystemfont\fP section.
o type1fonts
.PP
\fBtype1fonts\fP section defines \fBAdobe Type1 Fonts\fP can be used by MiniGUI. The pattern of this section is similiar with \fBsystemfont\fP section.
.SS
o bgpicture
.PP
\fBbgpicture\fP section defines the position of the background picture in MiniGUI.
.SS
o mouse
.PP
\fBmouse\fP section defines the mouse configuration data. No need to change this section.
.SS
o event
.PP
\fBevent\fP section defines the event handling configuration data. No need to change this section.
.SS
o cursorinfo
.PP
\fBcursorinfo\fP section defines the cursors can be used by MiniGUI. \fBcursorpath\fP key specifies the path of cursor files, and \fBcursornumber\fP key specifies the number of cursor should be loaded at startup of MiniGUI. \fBcursor0, cursor1, cursor2, ...\fP keys specify the name of each cursor file. If you define \fBcursornumber\fP as zero, there will be no mouse cursor displayed in MiniGUI application.
.SS
o iconinfo
.PP
\fBiconinfo\fP section defines the icons can be used by MiniGUI. \fBiconpath\fP key specifies the path of icon files, and \fBiconnumber\fP key specifies the number of icon should be loaded at startup of MiniGUI. \fBicon0, icon1, icon2, ...\fP keys specify the name of each icon file.
.SS
o bitmapinfo
.PP
\fBbitmapinfo\fP section defines the bitmaps used by MiniGUI. \fBbitmappath\fP key specifies the path of bitmap files, and other keys specify the bitmap file names. You can change the value of \fBbgpicture\fP key to specify a different background picture, or change the value of \fBlogo\fP key to specify a different logo picture. No need to change other values.
.SS
o mainwinmetrics
.PP
\fBmainwinmetrics\fP section defines the metrics of main windows.
.SS
o windowelementcolors
.PP
\fBwindowelementcolors\fP section defines colors of window elements in RGB.
.SS
o imeinfo
.PP
\fBimeinfo\fP section defines the Hanzi Input Methods can be used by MiniGUI. \fBimepath\fP key specifies the path of files used by IME, and \fBimenumber\fP key specifies the number of IME should be loaded at startup of IME window. \fBime0, ime1, ...\fP keys specify the name of each IME.
.SS
o appinfo
.PP
\fBappinfo\fP section defines the applications information of MiniGUI. So far, MiniGUI only uses this section to define the path storing application resource files.
.SH COPYING
.PP
Copyright (C) 2002 ~ 2004, Beijing Feynman Software Technology Co., Ltd.
.BR
Copyright (C) 1998 ~ 2002, Wei Yongming.
.BR
Portion copyright (C) 2000, Song Lixin, Zheng Xiang and othres..
.PP
MiniGUI is free woftware; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
.PP
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA

3
doc/man/man7/Makefile.am
View File

@@ -1,3 +0,0 @@
man_MANS=libminigui.7
EXTRA_DIST = $(man_MANS)

99
doc/man/man7/libminigui.7
View File

@@ -1,99 +0,0 @@
.TH libminigui 7 "Jan 2004" "libminigui" "Introduction to libminigui"
.SH NAME
libminigui \- A compact Graphics User Interface support system for real-time embedded systems based-on Linux.
.SH DESCRIPTION
.PP
MiniGUI is a LGPLed free software project.
Its goal is providing a lightweight Graphics User Interface support system;
especially fit for real-time embedded systems based on Linux. We have released
MiniGUI version 1.0.00Pre1 so far, and the official release version will be born
in the near future.
.PP
MiniGUI defines some Win32-like APIs for the applications. By using the
MiniGUI, one application can create multiple windows, and can draw in
these windows without interfering each other.
.PP
You can find latest information about MiniGUI at our home page:
.PP
http://www.minigui.org
.SH WHAT IS MINIGUI-LITE
.PP
You know that MiniGUI before version 0.9.98 is based on LinuxThreads.
Therefore, if you want to start a program based on MiniGUI, you have to
quit current one and start another one, or you can dynamically load the
program via 'dlopen'. Although the latter can extend your application
in some degrees, but it is not a good way because one thread in a MiniGUI-based
process may damage the whole process.
.PP
Now you can use MiniGUI-Lite to run more than one MiniGUI-based program
in the form of Linux processes at the same time. MiniGUI-Lite is a lightweight
version of original MiniGUI -- because LinuxThreads is not needed any more.
You can run a programm based on MiniGUI-Lite from a program called 'mginit'.
Just like X Window, the former process is called a client, and the latter a server.
.PP
The clients connect to the server via UNIX domain socket, and the server accepts
the request from clients. The server provides the shared resource for the clients,
and sends mouse (touch screen) and keyboard events to the topmost client.
If a client exit or die for a reason, the server will run as normal.
.PP
In our release, there is a package called 'mglite-exec'. In this package,
there is a 'mginit' program which creates a virtual console window. You can start
a program in this package from the command line of the virtual console.
You can even debug this program by using 'gbd'.
.PP
You can create many windows in a program based on MiniGUI-Lite, but you can not
start a new thread to create a window. So some functions in original MiniGUI can
not be used in MiniGUI-Lite, but most of APIs of MiniGUI-Lite are compatible with
original MiniGUI. Porting from original MiniGUI to MiniGUI-Lite is simple.
Please see the programs in 'mglite-exec' package, all programs are porting
from 'miniguiexec' package.
.PP
The source of MiniGUI is configured as MiniGUI-Lite by default.
When you run `./configure' to configure MiniGUI, you can use the command:
.PP
$ ./configure --disable-lite
.PP
to disable MiniGUI-Lite. You will get the original MiniGUI libraries which
run on PThread.
.PP
For clear distinguish, we will call MiniGUI based-on PThread as `MiniGUI-Threads'.
.SH AUTHOR
.PP
The original author of MiniGUI is WEI Yongming (ymwei@minigui.org), but many others added some features to MiniGUI, and some code of MiniGUI comes from other free software. For instance, the Chinses input method comes from CCE (Console Chinese Environment)
by He Rui and others, and ported it to MiniGUI by KANG Xiaoning and Zheng Xiang.
.PP
For other authors and contributors to see CREDITS.
.SH COPYING
.PP
Copyright (C) 1998, 1999, 2000, 2001, WEI Yongming.
.br
Copyright (C) 2000, 2001, BluePoint Software.
.br
Portion copyright (C) 2000, Song Lixin.
.br
Portion copyright (C) 2000, Zheng Xiang.
.PP
MiniGUI is free woftware; you can redistribute it and/or modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
.PP
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details.
.PP
You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA

14
doc/man3/Makefile.am
View File

@@ -1,14 +0,0 @@
man_MANS = minigui.3 miniguiFunctions.3 miniguiAccelerator.3 miniguiAsyncKey.3 miniguiBitmap.3 \
miniguiCaretHandler.3 miniguiClipRectHeap.3 miniguiCreateWindow.3 \
miniguiCursor.3 miniguiDC.3 miniguiDCAttr.3 miniguiDCClipping.3 \
miniguiDTI.3 miniguiDialogBox.3 miniguiDrawing.3 miniguiEtcFile.3 \
miniguiFixStr.3 miniguiHook.3 miniguiIME.3 miniguiIcon.3 miniguiInit.3 \
miniguiLogFont.3 miniguiMain.3 miniguiMainWindow.3 miniguiMapTransf.3 \
miniguiMapping.3 miniguiMenu.3 miniguiMessage.3 miniguiMisc.3 \
miniguiPenBrush.3 miniguiRect.3 miniguiRegion.3 miniguiScreen.3 \
miniguiString.3 miniguiSysChar.3 miniguiTextOutput.3 miniguiTextParse.3 \
miniguiTimer.3 miniguiWindowClass.3 miniguiGetSysText.3 \
miniguiMessages.3 miniguiStructures.3 miniguiControls.3 \
miniguiLite.3
EXTRA_DIST = $(man_MANS) docmaker functions.txt

84
doc/man3/docmaker
View File

@@ -1,84 +0,0 @@
#! /usr/bin/perl -w
use POSIX;
if ($#ARGV < 0) {
print "Usage: ./docmaker functions.txt\n";
exit -1;
}
open FUNCHANDLE, "<$ARGV[0]" || die;
$i = 0;
while (<FUNCHANDLE>) {
next if /^\n/;
chop;
if (/^(\D.+?) \\-.+$/){
$docfile = "minigui$1.3";
open DOC, ">$docfile" || die;
print DOC ".\\\" This manpage is Copyright (C) 2000, 2001 Wei Yongming\n";
print DOC ".\\\" 2000, 2001 BluePoint Software\n";
print DOC ".\\\"\n";
print DOC ".\\\" Permission is granted to make and distribute verbatim copies of this\n";
print DOC ".\\\" manual provided the copyright notice and this permission notice are\n";
print DOC ".\\\" preserved on all copies.\n";
print DOC ".\\\"\n";
print DOC ".\\\" Permission is granted to copy and distribute modified versions of this\n";
print DOC ".\\\" manual under the conditions for verbatim copying, provided that the\n";
print DOC ".\\\" entire resulting derived work is distributed under the terms of a\n";
print DOC ".\\\" permission notice identical to this one.\n";
print DOC ".\\\"\n";
print DOC ".\\\" Since MiniGUI is constantly changing, this\n";
print DOC ".\\\" manual page may be incorrect or out-of-date. The author(s) assume no\n";
print DOC ".\\\" responsibility for errors or omissions, or for damages resulting from\n";
print DOC ".\\\" the use of the information contained herein. The author(s) may not\n";
print DOC ".\\\" have taken the same level of care in the production of this manual,\n";
print DOC ".\\\" which is licensed free of charge, as they might when working\n";
print DOC ".\\\" professionally.\n";
print DOC ".\\\"\n";
print DOC ".\\\" Formatted or processed versions of this manual, if unaccompanied by\n";
print DOC ".\\\" the source, must acknowledge the copyright and authors of this work.\n";
print DOC ".TH \"$1\" ";
print DOC "\"3\" \"August 2000\" \"MiniGUI\"\n\n";
print DOC ".SH \"NAME\"\n";
print DOC "$_\n\n";
print DOC ".SH \"SYNOPSIS\"\n";
}
elsif (/^#.+?/){
print DOC ".B $_\n";
print DOC ".br\n";
}
else{
$funcname[$i++]=$_;
}
}
print DOC "\n.PP\n";
for ($j = 0; $j < $i; $j++){
$funcname[$j] =~ /(.+?) *(\(.+?\);)/;
$funcname[$j] = $1;
print DOC ".BI \"$1\" \"$2\"\n";
print DOC ".br\n" if ($j != $i - 1);
}
print DOC ".SH \"DESCRIPTION\"\n";
print DOC ".PP\n";
for ($j = 0; $j < $i; $j++){
$funcname[$j] =~ /.+ (.+?)$/;
print DOC "\\fB$1\\fP function description goes here\n";
print DOC ".PP\n" if ($j != $i - 1);
# open FUNCDOC, ">$1.3" || die;
# print FUNCDOC ".so man3/$docfile\n";
# close FUNCDOC;
}
print DOC ".SH \"RETURN VALUE\"\n";
print DOC ".PP\n\n";
print DOC ".SH \"NOTE\"\n";
print DOC ".PP\n\n";
print DOC ".SH \"SEE ALSO\"\n\n";
print DOC ".SH \"AUTHOR\"\n";
print DOC ".PP\n";
print DOC "This manual page was edited by <yourname> <yourid\@minigui.org>.\n";
print DOC "If you have any problems, comments or found some bugs, please send messages to me.\n";
close FUNCHANDLE;
close DOC;

19
doc/man3/functions.txt
View File

@@ -1,19 +0,0 @@
New \- MiniGUI-Lite version specified functions.
#include <minigui/minigui.h>
BOOL GUIAPI SetDesktopRect (int lx, int ty, int rx, int by);
void GUIAPI GetDesktopRect (int* lx, int* ty, int* rx, int* by);
BOOL GUIAPI ServerStartup (void);
BOOL GUIAPI SetClientScreen (int lx, int ty, int rx, int by);
BOOL GUIAPI OnlyMeCanDraw (void);
BOOL GUIAPI ClientCanDrawNowEx (BOOL bRepaint);
BOOL GUIAPI SetTopMostClient (int cli);
int GUIAPI GetClientByPID (int pid);
int cli_request (PREQUEST request, void* result, int len_rslt);
BOOL GUIAPI RegisterRequestHandler (int req_id, REQ_HANDLER your_handler);
REQ_HANDLER GUIAPI GetRequestHandler (int req_id);
int get_sock_fd2srv (void);
int sock_write (int fd, const void* buff, int count);
int sock_read (int fd, void* buff, int count);
BOOL GUIAPI Send2TopMostClient (int iMsg, WPARAM wParam, LPARAM lParam);

48
doc/man3/minigui.3
View File

@@ -1,48 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" Modified 2000/11/30 by Wei Yongming.
.TH "minigui" "3" "August 2000" "MiniGUI"
.SH "NAME"
minigui \- Guide for manpages of MiniGUI version 1.x.
.SH "DESCRIPTION"
.TP
.BR miniguiFunctions (3)
Function list of MiniGUI version 1.x. Gives the brief description for functions of MiniGUI.
.TP
.BR miniguiMessages (3)
Message list of MiniGUI version 1.x. Gives the brief description for messages of MiniGUI.
.TP
.BR miniguiStructures (3)
Structure list of MiniGUI version 1.x. Gives the brief description for structures of MiniGUI.
.TP
.BR miniguiControls (3)
Brief description of usage of MiniGUI built-in controls.
.SH "AUTHOR"
.PP
This manual page was edited by Wei Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

70
doc/man3/miniguiAccelerator.3
View File

@@ -1,70 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" Modified 2000/11/30 by Wei Yongming.
.TH "Accelerator" "3" "August 2000" "MiniGUI"
.SH "NAME"
Accelerator \- Accelerator support functions
.SH "SYNOPSIS"
.B #include <minigui/window.h>
.br
.PP
.BI "HACCEL GUIAPI CopyAcceleratorTable" "(HACCEL hacc);"
.br
.BI "int GUIAPI DeleteAccelerators" "(HACCEL hacc, int key, DWORD keymask);"
.br
.BI "int GUIAPI AddAccelerators" "(HACCEL hacc,int key, DWORD keymask, WPARAM wParam, LPARAM lParam);"
.br
.BI "int GUIAPI DestroyAcceleratorTable" "(HACCEL hacc);"
.br
.BI "HACCEL GUIAPI CreateAcceleratorTable" "(HWND hWnd);"
.br
.BI "HACCEL GUIAPI LoadAccelerators" "(const char* filename, int id);"
.SH "DESCRIPTION"
.PP
\fBCopyAcceleratorTable\fP function copies the specified accelerator table. This function is used to obtain the accelerator-table data that corresponds to an accelerator-table handle, or to determine the size of the accelerator-table data.
.PP
\fBDeleteAccelerators\fP function deletes an accelerator from the accelerator table.
.PP
\fBAddAccelerators\fP function adds an accelerator to the accelerator table. It's called after you call \fBCreateAcceleratorTable\fP function.
.PP
\fBDestroyAcceleratorTable\fP function destroys an accelerator table. Before closing a window, you must call this function to destroy each accelerator table that is created by using the \fBCreateAcceleratorTable\fP function.
.PP
\fBCreateAcceleratorTable\fP function creates an accelerator table.
.PP
\fBLoadAccelerators\fP function loads the specified accelerator table. This function has not been implemented.
.SH "RETURN VALUE"
.PP
.SH "NOTE"
.PP
.SH "SEE ALSO"
.SH "AUTHOR"
.PP
This manual page was edited by Song Lixin <zjujoe@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

86
doc/man3/miniguiAsyncKey.3
View File

@@ -1,86 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "AsyncKey" "3" "July 2000" "MiniGUI"
.SH "NAME"
AsyncKey \- Gets asynchronize key status in MiniGUI.
.SH "SYNOPSIS"
.B #include <minigui/minigui.h>
.PP
.BI "BOOL GUIAPI GetKeyStatus" "(UINT uKey);"
.br
.BI "DWORD GUIAPI GetShiftKeyStatus" "(void);"
.SH "DESCRIPTION"
.PP
\fBGetKeyStatus\fP gets a key or a mouse button status, return TRUE when pressed, or FALSE when released. \fBuKey\fP indicates the key or mouse button. For keys on keyboard, \fBuKey\fP should be the scancode of the key, for mouse button, \fBuKey\fP should be one value of the following:
.PP
.IP \fBSCANCODE_LEFTBUTTON\fP
Left mouse button.
.IP \fBSCANCODE_MIDDLBUTTON\fP
Middle mouse button.
.IP \fBSCANCODE_RIGHTBUTTON\fP
Right mouse button.
.PP
The above constants and the scancodes of keys are defined in \fB<minigui/common.h>\fP.
.PP
\fBGetShiftKeyStatus\fP gets status of shift keys, the returned value indicates the status of shift keys -- \fBCapsLock, ScrollLock, NumLock, Left Shift, Right Shift, Left Ctrl, Right Ctrl, Left Alt, and Right Alt\fP. You can use KS_* with OR operation to determine one shift key's status:
.PP
.IP \fBKS_CAPSLOCK\fP
Indicates that CapsLock is locked.
.IP \fBKS_NUMLOCK\fP
Indicates that NumLock is locked.
.IP \fBKS_SCROLLLOCK\fP
Indicates that ScrollLock is locked.
.IP \fBKS_LEFTCTRL\fP
Indicates that left Ctrl is pressed.
.IP \fBKS_RIGHTCTRL\fP
Indicates that right Ctrl is pressed.
.IP \fBKS_CTRL\fP
Indicates that one Ctrl is pressed.
.IP \fBKS_LEFTALT\fP
Indicates that left Alt is pressed.
.IP \fBKS_RIGHTALT\fP
Indicates that right Alt is pressed.
.IP \fBKS_ALT\fP
Indicates that one Alt is pressed.
.IP \fBKS_LEFTSHIFT\fP
Indicates that left Shift is pressed.
.IP \fBKS_RIGHTSHIFT\fP
Indicates that right Shift is pressed.
.IP \fBKS_SHIFT\fP
Indicates that one Shift is pressed.
.PP
The above constants are defined in \fB<minigui/common.h>\fP.
.SH "SEE ALSO"
.BR MSG_KEYDOWN (3),
.BR MSG_KEYUP (3),
.BR MSG_CHAR (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

100
doc/man3/miniguiBitmap.3
View File

@@ -1,100 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "Bitmap" "3" "August 2000" "MiniGUI"
.SH "NAME"
Bitmap \- bitmap operations in MiniGUI.
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.PP
.BI "int GUIAPI LoadBitmap" "(HDC hdc, PBITMAP pBitmap, const char* spFileName);"
.br
.BI "int GUIAPI CreateBitmapFromGIFFile" "(HDC hdc, PBITMAP pBitmap, const char* spFileName);"
.br
.BI "int GUIAPI CreateBitmapFromGIFMemory" "(HDC hdc, PBITMAP pBitmap, void* GIFBuff, int nSize);"
.br
.BI "int GUIAPI CreateBitmapFromJPGFile" "(HDC hdc, PBITMAP pBitmap, const char* spFileName);"
.br
.BI "int GUIAPI CreateBitmapFromJPGMemory" "(HDC hdc, PBITMAP pBitmap, void* JPGBuff, int nSize);"
.br
.BI "void GUIAPI UnloadBitmap" "(PBITMAP pBitmap);"
.PP
.BI "void GUIAPI ReplaceBitmapColor" "(HDC hdc, PBITMAP pBitmap, int iOColor, int iNColor);"
.PP
.BI "void GUIAPI FillBox" "(HDC hdc, int x, int y, int w, int h);"
.br
.BI "void GUIAPI FillBoxWithBitmap" "(HDC hdc, int x, int y, int w, int h, PBITMAP pBitmap);"
.br
.BI "void GUIAPI FillBoxWithBitmapPart" "(HDC hdc, int x, int y, int w, int h, int bw, int bh, PBITMAP pBitmap, int xo, int yo);"
.br
.BI "void GUIAPI BitBlt" "(HDC hsdc, int sx, int sy, int sw, int sh, HDC hddc, int dx, int dy, DWORD dwRop);"
.br
.BI "void GUIAPI StretchBlt" "(HDC hsdc, int sx, int sy, int sw, int sh, HDC hddc, int dx, int dy, int dw, int dh, DWORD dwRop);"
.br
.SH "DESCRIPTION"
.PP
\fBLoadBitmap\fP function loads a bitmap from a bitmap file named \fBspFileName\fP into a BITMAP struct pointed to by \fBpBitmap\fP. This function will create a compiled bitmap compatible with the DC \fBhdc\fP. You can load BMP, PCX, TGA, GIF, JPG, PNG bitmap files by using this function. Note that you should specify correct extenstion name of the file.
.PP
\fBCreateBitmapFromGIFFile\fP function create a bitmap from a GIF image file named \fBspFileName\fP. This function will create a compiled bitmap compatible with the DC \fBhdc\fP. This function is the old interface to load GIF file, and reserved only for compatibility. New application should use \fBLoadBitmap\fP to load GIF file.
.PP
\fBCreateBitmapFromGIFMemory\fP function create a bitmap from a buffer filled with data from a GIF image file. \fBnSize\fP specifies the size of the buffer pointed to by \fBGIFBuf\fP. This function will create a compiled bitmap compatible with the DC \fBhdc\fP. This function is the old interface to load JPG file, and reserved only for compatibility. New application should use \fBLoadBitmap\fP to load JPG file.
.PP
\fBCreateBitmapFromJPGFile\fP function is similar with \fBCreateBitmapFromGIFFile\fP, but this function used to create bitmap from a JPG image file. This function is a obsoleted one, new application should use \fBLoadBitmap\fP instead.
.PP
\fBCreateBitmapFromJPGMemory\fP function is similar with \fBCreateBitmapFromGIFMemory\fP, but the buffer is filled with data from a JPG image file. This function is a obsoleted one, new application should use \fBLoadBitmap\fP instead.
.PP
\fBUnloadBitmap\fP function frees the memory used by the bitmap object pointed to by \fBpBitmap\fP.
.PP
\fBReplaceBitmapColor\fP function replaces a color \fB(nOColor)\fP with a new color \fB(nNColor)\fP in the bitmap object pointed to by \fBpBitmap\fP.
.PP
\fBFillBox\fP function fills a box with the current brush in the DC \fBhdc\fP. Note that MiniGUI only defined the color property for the brush objects.
.PP
\fBFillBoxWithBitmap\fP function fills a box with a bitmap object pointed to by \fBpBitmap\fP. \fB(x, y)\fP is the upper-left corner of the box, and \fBw, h\fP are the width and the height of the box respectively. This function will scale the bitmap when necessary; that is, the width or the height of the box are not equal to the with or the height of the bitmap object.
.PP
\fBFillBoxWithBitmapPart\fP function fills a box with a part of a bitmap oject pointed to by \fBpBitmap\fP. \fB(x, y)\fP is the upper-left corner of the box, and \fBw, h\fP are the width and the height of the box respectively. \fB(xo, yo)\fP is the start position of the part box in the bitmap relative to upper-left corner of the bitmap, and \fBbw, bh\fP are the width and the height of the full bitmap you want. If \fBbw\fP or \fBbh\fP is less than or equal to zero, this function will use the original width and height of the bitmap, else it will scale the bitmap first when necessary.
.PP
\fBBitBlt\fP function performs a bit-block transfer of the color data cooresponding to a rectangle of pixels from the specfied source dispaly context \fBhsdc\fP into a destination display context \fBhddc\fP. \fB(sx, sy, sw, sh)\fP specifies the rectangle in the source DC, and \fB(dx, dy)\fP specifies the position of the rectangle in the destination DC. Note that the size of the two rectangles are identical.
.PP
\fBStretchBlt\fP function copies a bitmap from a source rectangle into a destination rectangle, streching or compressing the bitmap to fit the dimension of the destination rectangle, if necessary. This function is similar with \fBBitBlt\fP function except the former scaling the bitmap. \fB(dw, dh)\fP specifies the size of the destination rectangle.
.SH "RETURN VALUE"
.PP
For the functions creating bitmap objects, they will return non-zero values to indicate errors.
.SH "NOTE"
.PP
\fBLoadBitmap\fP function only supports bitmap files with less than 256 colors, and without RLE encoding. The GIF and JPG functions only support some formats, and the GIF functions can not support the GIF animation.
.SH "SEE ALSO"
.BR SetBrushColor (3)
.SH "TODO"
.PP
A \fBMaskBlt\fP function which combines the color data for the source and destination bitmaps using the specified mask is needed.
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

83
doc/man3/miniguiCaretHandler.3
View File

@@ -1,83 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "CaretHandler" "3" "August 2000" "MiniGUI"
.SH "NAME"
CaretHandler \- Caret support in MiniGUI.
.SH "SYNOPSIS"
.B #include <minigui/window.h>
.PP
.BI "BOOL GUIAPI CreateCaret" "(HWND hWnd, PBITMAP pBitmap, int nWidth, int nHeight);"
.br
.BI "BOOL GUIAPI ChangeCaretSize" "(HWND hWnd, int newWidth, int newHeight);"
.br
.BI "BOOL GUIAPI ActiveCaret" "(HWND hWnd);"
.br
.BI "UINT GUIAPI GetCaretBlinkTime" "(HWND hWnd);"
.br
.BI "BOOL GUIAPI SetCaretBlinkTime" "(HWND hWnd, UINT uTime);"
.br
.BI "BOOL GUIAPI DestroyCaret" "(HWND hWnd);"
.br
.BI "BOOL GUIAPI HideCaret" "(HWND hWnd);"
.br
.BI "BOOL GUIAPI ShowCaret" "(HWND hWnd);"
.br
.BI "BOOL GUIAPI SetCaretPos" "(HWND hWnd, int x, int y);"
.br
.BI "BOOL GUIAPI GetCaretPos" "(HWND hWnd, PPOINT pPt);"
.SH "DESCRIPTION"
.PP
\fBCreateCaret\fP function creates a new shape for the system caret and assigns ownership of the caret to the specified window. The caret shape can be a line, a block, or a bitmap.
.PP
\fBChangeCaretSize\fP function changes the size(width and height) of the caret owned by the specified window.
.PP
\fBActiveCaret\fP function activates the caret owned by specified window.
.PP
\fBGetCaretBlinkTime\fP function returns the elapsed time, in milliseconds, required to invert the caret's pixels.
.PP
\fBSetCaretBlinkTime\fP function sets the caret blink time to the specified number of milliseconds. The blink time is the elapsed time, in milliseconds, required to invert the caret's pixels.
.PP
\fBDestroyCaret\fP function destroys the caret's current shape, frees the caret from the window, and removes the caret from the screen.
.PP
\fBHideCaret\fP function removes the caret from the screen. Hiding a caret does not destroy its current shape or invalidate the insertion point.
.PP
\fBShowCaret\fP function makes the caret visible on the screen at the caret's current position. When the caret becomes visible, it begins flashing automatically.
.PP
\fBSetCaretPos\fP function moves the caret to the specified coordinates.
.PP
\fBGetCaretPos\fP function copies the caret's position, in client coordinates, to the specified \fBPOINT\fP structure
.SH "RETURN VALUE"
.PP
.SH "NOTE"
.PP
.SH "SEE ALSO"
.SH "AUTHOR"
.PP
This manual page was edited by Song Lixin <zjujoe@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

90
doc/man3/miniguiClipRectHeap.3
View File

@@ -1,90 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "ClipRectHeap" "3" "August 2000" "MiniGUI"
.SH "NAME"
ClipRectHeap \- Management of private clip rect heap.
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.PP
.BI "BOOL GUIAPI InitFreeClipRectList" "(PFREECLIPRECTLIST pList, size_t size);"
.br
.BI "PCLIPRECT GUIAPI ClipRectAlloc" "(PFREECLIPRECTLIST pList);"
.br
.BI "void GUIAPI FreeClipRect" "(PFREECLIPRECTLIST pList, CLIPRECT* pRect);"
.br
.BI "void GUIAPI EmptyFreeClipRectList" "(PFREECLIPRECTLIST pList);"
.br
.BI "void GUIAPI DestroyFreeClipRectList" "(PFREECLIPRECTLIST pList);"
.SH "DESCRIPTION"
.PP MiniGUI uses internal rect heap to allocate and free clip rect for region efficiently. When define a region, which was composed with many clip rects, you must specify a free clip rect list as the heap of the region to allocate and free clip rects. The functions describing here can help you initialize a clip rect heap, and allocate and free clip rect from it.
.PP
\fBInitFreeClipRectList\fP function allocates memory from system heap for free clip rect list, and initializes the list specified by \fBpList\fP. The number of clip rects in the list is \fBsize\fP.
.PP
Clip rect and free clip rect list in MiniGUI are defined as follows:
.sp
.nf
typedef struct tagCLIPRECT
{
.in +8
RECT rc;
BOOL fromheap;
struct tagCLIPRECT* next;
.in -8
}CLIPRECT;
typedef CLIPRECT* PCLIPRECT;
typedef struct tagFREECLIPRECTLIST
{
.in +8
pthread_mutex_t lock;
PCLIPRECT head;
PCLIPRECT tail;
int size;
PCLIPRECT heap;
int free;
.in -8
}FREECLIPRECTLIST;
typedef FREECLIPRECTLIST* PFREECLIPRECTLIST;
.fi
.PP
\fBClipRectAlloc\fP function allocates a clip rect from the initialized list \fBpList\fP. If there is no left item in the heap, it will try to allocate the clip rect from system heap. This function returns a pointer to the allocated clip rect, \fBNULL\fP when an error occurred.
.PP
\fBFreeClipRect\fP function frees the clip rect \fBpRect\fP allocated by \fBClipRectAlloc\fP.
.PP
\fBEmptyFreeClipRectList\fP function resets the heap used by \fBpList\fP. If there is any clip rect allocated from the system heap, this function will free it using \fBfree\fP.
.PP
\fBDestroyFreeClipRectList\fP function destroys the free clip list \fBpList\fP by empting the list and freeing the heap.
.SH "NOTE"
.PP
Although you can use these function to allocate and free clip rect, you should avoid using this function directly. Functions of region will use these function to manipulate the clip rect.
.SH "SEE ALSO"
.BR InitClipRgn (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

34
doc/man3/miniguiControls.3
View File

@@ -1,34 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "Controls" "3" "Nov. 2000" "MiniGUI"
.SH "NAME"
Controls \- Brief discription of usage of built-in controls.
.PP
This page is under construction.
.SH "AUTHOR"
.PP
This manual page was edited by Wei Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

56
doc/man3/miniguiCreateWindow.3
View File

@@ -1,56 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "CreateDestroyWindow" "3" "August 2000" "MiniGUI"
.SH "NAME"
CreateDestroyWindow \- Create and Destroy Window
.SH "SYNOPSIS"
.B #include <minigui/window.h>
.br
.PP
.BI "HWND GUIAPI CreateWindow" "(const char* spClassName, const char* spCaption, DWORD dwStyle, int id, int x, int y, int w, int h, HWND hParentWnd, DWORD dwAddData);"
.br
.BI "HWND GUIAPI CreateWindowEx" "(const char* spClassName, const char* spCaption, DWORD dwStyle, DWORD dwExStyle, int id, int x, int y, int w, int h, HWND hParentWnd, DWORD dwAddData);"
.br
.BI "BOOL GUIAPI DestroyWindow" "(HWND hWnd);"
.SH "DESCRIPTION"
.PP
\fBCreateWindow\fP function creates a child window. It specifies the window class, window title, window style, and the initial position and size of the window. The function also specifies the window's parent or owner, if any.
.PP
\fBCreateWindowEx\fP function creates a child window with extended styles. It specifies the window class, window title, window style, windows extended styles, and the initial position and size of the window. The function also specifies the window's parent or owner, if any.
.PP
\fBDestroyWindow\fP function destroys the specified window. The function sends \fBWM_DESTROY\fP and \fBWM_NCDESTROY\fP messages to the window to deactivate it and remove the keyboard focus from it.
.SH "RETURN VALUE"
.PP
.SH "NOTE"
.PP
.SH "SEE ALSO"
.SH "AUTHOR"
.PP
This manual page was edited by Song Lixin <zjujoe@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

113
doc/man3/miniguiCursor.3
View File

@@ -1,113 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "Cursor" "3" "July 2000" "MiniGUI"
.SH NAME
Cursor \- the functions handling cursor in MiniGUI
.SH SYNOPSIS
.B #include <minigui/minigui.h>
.PP
.BI "HCURSOR GUIAPI LoadCursorFromFile" "(const char* filename);"
.br
.BI "HCURSOR GUIAPI CreateCursor" "(int xhotspot, int yhotspot, int w, int h, const BYTE* pANDBits, const BYTE* pXORBits, int colornum);"
.br
.BI "BOOL GUIAPI DestroyCursor" "(HCURSOR hcsr);"
.br
.BI "HCURSOR GUIAPI GetSystemCursor" "(int csrid);"
.br
.BI "HCURSOR GUIAPI GetCurrentCursor" "(void);"
.br
.BI "void GUIAPI ClipCursor" "(const RECT* prc);"
.br
.BI "void GUIAPI GetClipCursor" "(RECT* prc);"
.br
.BI "void GUIAPI GetCursorPos" "(POINT* ppt);"
.br
.BI "void GUIAPI SetCursorPos" "(int x, int y);"
.br
.BI "HCURSOR GUIAPI SetCursor" "(HCURSOR hcsr);"
.br
.BI "int GUIAPI ShowCursor" "(BOOL fShow);"
.br
.BI "BOOL GUIAPI RefreshCursor" "(int* x, int* y, int* button);"
.br
.SH DESCRIPTION
.PP
\fBLoadCursorFromFile\fP function loads a cursor from Windows *.cur file named \fBfilename\fP and returns the handle of loaded cursor. The returned handle can be used by \fBSetCursor\fP to set new mouse cursor.
.PP
\fBCreateCursor\fP function creates a cursor from memory data rather than cursor file. \fBxhotspot\fP and \fByhotspot\fP specify hotpot of the cursor, \fBw\fP and \fBh\fP are the width and the height of the cursor respectively. \fBfANDBits\fP and \fBfXORBits\fP are AND bitmask and XOR bitmask of the cursor. MiniGUI currently support mono-color cursor and 16-color cursor, \fBcolornum\fP specifies the cursor's color number. For mono-color, it should be 1, and for 16-color cursor, it should be 4.
.PP
\fBDestroyCursor\fP function destroys a cursor object specified by \fBhcsr\fP.
.PP
\fBGetSystemCursor\fP function gets a system default cursor object. When startup, MiniGUI loads system cursors according to MiniGUI.cfg file. There are 14 system cursors by default, and can be refered with the following IDs:
.SH Cursor IDs
.IP \fBIDC_ARROW\fR
Normal arrow cursor
.IP \fBIDC_IBEAM\fR
I-shape cursor, indicate an input field
.IP \fBIDC_PENCIL\fR
Pencil-shape cursor
.IP \fBIDC_CROSS\fR
Cross cursor
.IP \fBIDC_MOVE\fR
Moving cursor
.IP \fBIDC_SIZENWSE\fR
Sizing cursor, along north-west and south-east
.IP \fBIDC_SIZENESW\fR
Sizing cursor, along north-east and south-west
.IP \fBIDC_SIZEWE\fR
Sizing cursor, along west and east
.IP \fBIDC_SIZENS\fR
Sizing cursor, along north and south
.IP \fBIDC_UPARROW\fR
Up arrow cursor
.IP \fBIDC_NONE\fR
None cursor
.IP \fBIDC_HELP\fR
Arrow with question
.IP \fBIDC_BUSY\fR
Busy cursor
.IP \fBIDC_WAIT\fR
Wait cursor
.PP
Returned cursor handle can be used by \fBSetCursor\fP to set new mouse cursor. Note that you should not destroy any system cursor.
.PP
\fBGetCurrentCursor\fP function gets the handle of current cursor.
.PP
\fBClipCursor\fP function sets cursor's clipping rectangle. \fBprc\fP is the new clipping rectangle in screen coordinates. If \fBprc\fP is NULL, \fBClipCursor\fP will disable cursor clipping.
.PP
\fBGetClipCursor\fP function copies current clipping rectangle to a RECT pointed to by \fBprc\fP.
.PP
\fBGetCursorPos\fP function copies current mouse postion to a POINT pointed to by \fBppt\fP.
.PP
\fBSetCursorPos\fP function sets mouse position with given parameter \fBx,y\fP.
.PP
\fBSetCursor\fP function sets cursor to given cursor handle. \fBhcsr\fP can be a handle returned by \fBLoadCursor\fP, \fBCreateCursor\fP, and \fBGetSystemCursor\fP. This function will return the previous cursor handle.
.PP
\fBShowCursor\fP function shows or hides cursor according to parameter \fBfShow\fP. Show cursor when \fBfShow\fP is TRUE, and hide cursor when \fBfShow\fP is FALSE.
.PP
\fBRefreshCursor\fP function updates cursor position and status, and return new position in \fBx, y\fP, new buttion status in \fBbutton\fP. The returned value indicates whether mouse has moved, \fBTRUE\fP for moved.
.SH AUTHOR
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

84
doc/man3/miniguiDC.3
View File

@@ -1,84 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "DC" "3" "August 2000" "MiniGUI"
.SH "NAME"
DC \- get and release display context.
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.PP
.BI "HDC GUIAPI GetDC" "(HWND hwnd);"
.br
.BI "HDC GUIAPI GetClientDC" "(HWND hwnd);"
.br
.BI "void GUIAPI ReleaseDC" "(HDC hdc);"
.PP
.BI "HDC GUIAPI CreateCompatibleDC" "(HDC hdc);"
.br
.BI "void GUIAPI DeleteCompatibleDC" "(HDC hdc);"
.PP
.BI "HDC GUIAPI CreatePrivateDC" "(HWND hwnd);"
.br
.BI "HDC GUIAPI CreatePrivateClientDC" "(HWND hwnd);"
.br
.BI "HDC GUIAPI GetPrivateClientDC" "(HWND hwnd);"
.br
.BI "void GUIAPI DeletePrivateDC" "(HDC hdc);"
.SH "DESCRIPTION"
.PP
\fBGetDC\fP function gets a window DC of the specified \fBhwnd\fP, and returns the handle of the DC.
.PP
\fBGetClientDC\fP function gets a client DC of the specified \fBhwnd\fP, and returns the handle of the DC.
.PP
\fBReleaseDC\fP function releases the DC returned by \fBGetDC\fP or \fBGetClientDC\fP.
.PP
\fBCreateCompatibleDC\fP function creates a DC which is compatible with specified \fBhdc\fP, and returns the handle of the DC.
.PP
\fBDeleteCompatibleDC\fP function deletes the DC created by \fBCreateCompatibleDC\fP.
.PP
\fBCreatePrivateDC\fP function creates a private window DC of the window \fBhwnd\fP and returns the handle of the DC. This DC is created in system heap, rather than allocated from DC pool.
.PP
\fBCreatePrivateClientDC\fP function creates a private client DC of the window \fBhwnd\fP and returns the handle of the DC. This DC is created in system heap, rather than allocated from DC pool.
.PP
\fBGetPrivateClientDC\fP function returns the private client DC of the window \fBhwnd\fP with style WS_EX_USEPRIVATECDC.
.PP
\fBDeletePrivateDC\fP function deletes the DC returned by \fBCreatePrivateDC\fP or \fBCreatePrivateClientDC\fP.
.SH "RETURN VALUE"
.PP
For the \fBCreate...\fP or \fBGet...\fP functions, the functions will return the handle of the DC. The functions will return HDC_INVALID when an error occurred.
.SH "NOTE"
.PP
MiniGUI uses \fBCreatePrivateDC\fP and \fBCreatePrivateClientDC\fP to create private DC for the window with style WS_EX_USEPRIVATECDC. You can create a private DC to avoid invorking \fBGetDC\fP or \fBGetClientDC\fP to get DC when you receive a MSG_CREATE message. Note that you should call \fBDeletePrivateDC\fP to delete the private DC.
.SH "SEE ALSO"
.BR BeginPaint (3),
.BR EndPaint (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

106
doc/man3/miniguiDCAttr.3
View File

@@ -1,106 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "DCAttr" "3" "August 2000" "MiniGUI"
.SH "NAME"
DCAttr \- get/set the general attributes of DC.
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.br
.PP
.BI "int GUIAPI GetGDCapability" "(HDC hdc, int iItem);"
.PP
.BI "int GUIAPI SetBkMode" "(HDC hdc, int bkmode);"
.br
.BI "int GUIAPI GetBkMode" "(HDC hdc);"
.PP
.BI "gal_pixel GUIAPI GetBkColor" "(HDC hdc);"
.br
.BI "gal_pixel GUIAPI SetBkColor" "(HDC hdc, gal_pixel color);"
.PP
.BI "gal_pixel GUIAPI GetTextColor" "(HDC hdc);"
.br
.BI "gal_pixel GUIAPI SetTextColor" "(HDC hdc, gal_pixel color);"
.PP
.BI "int GUIAPI GetTabStop" "(HDC hdc);"
.br
.BI "int GUIAPI SetTabStop" "(HDC hdc, int new_value);"
.SH "DESCRIPTION"
.PP
\fBGetGDCapability\fP function returns a capability specified by \fBiItem\fP of the DC \fBhdc\fP. \fBiItem\fP can be one of the following values:
.PP
.IP \fBGDCAP_COLORNUM\fP
Tell \fBGetDCCapability\fP to return the colors number of the DC.
.IP \fBGDCAP_HPIXEL\fP
Tell \fBGetDCCapability\fP to return the horizontal resolution of the DC.
.IP \fBGDCAP_VPIXEL\fP
Tell \fBGetDCCapability\fP to return the vertical resolution of the DC.
.IP \fBGDCAP_MAXX\fP
Tell \fBGetDCCapability\fP to return the maximal visible x value of the DC.
.IP \fBGDCAP_MAXY\fP
Tell \fBGetDCCapability\fP to return the maximal visible y value of the DC.
.IP \fBGDCAP_DEPTH\fP
Tell \fBGetDCCapability\fP to return the color depth of the DC. The returned value can be 1, 4, 8, 15, 16, 24, or 32.
.IP \fBGDCAP_BPP\fP
Tell \fBGetDCCapability\fP to return the bytes number for storing a pixle in the DC.
.PP
\fBGetBkColor\fP function gets the background color of the DC.
.PP
\fBSetBkColor\fP function sets the background color of the DC to the color specified by \fBcolor\fP.
.PP
\fBGetBkMode\fP function gets the background mode of the DC.
.PP
\fBSetBkMode\fP function sets the background mode of the DC. Background modes in MiniGUI are:
.PP
.IP \fBBM_TRANSPARENT\fP
Indicate that reserve the background untouched when draw text.
.IP \fBBM_OPAQUE\fP
Indicate that erase the background with background color when draw text.
.PP
\fBGetTextColor\fP function gets the text color of the DC.
.PP
\fBSetTextColor\fP function sets the text color to the color specified by \fBcolor\fP.
.PP
\fBGetTabStop\fP function gets the tab stops of the DC.
.PP
\fBSetTabStop\fP function sets the tab stops of the DC to the new value specified by \fBnew_value\fP.
.SH "RETURN VALUE"
.PP
The \fBGet...\fP functions return the value wanted. The \fBSet...\fP functions return the old value.
.SH "SEE ALSO"
.BR RGB2Pixel (3),
.BR TextOut (3),
.BR TabbedTextOutLen (3),
.BR TabbedTextOutEx (3),
.BR DrawText (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

78
doc/man3/miniguiDCClipping.3
View File

@@ -1,78 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "DCClipping" "3" "August 2000" "MiniGUI"
.SH "NAME"
DCClipping \- Clipping support in MiniGUI.
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.br
.PP
.BI "void GUIAPI ExcludeClipRect" "(HDC hdc, int left, int top, int right, int bottom);"
.br
.BI "void GUIAPI IncludeClipRect" "(HDC hdc, int left, int top, int right, int bottom);"
.br
.BI "void GUIAPI ClipRectIntersect" "(HDC hdc, const RECT* prc);"
.br
.BI "void GUIAPI SelectClipRect" "(HDC hdc, const RECT* prc);"
.br
.BI "void GUIAPI SelectClipRegion" "(HDC hdc, const CLIPRGN* pRgn);"
.br
.BI "void GUIAPI GetBoundsRect" "(HDC hdc, RECT* pRect);"
.br
.BI "BOOL GUIAPI PtVisible" "(HDC hdc, const POINT* pPt);"
.br
.BI "BOOL GUIAPI RectVisible" "(HDC hdc, const RECT* pRect);"
.SH "DESCRIPTION"
.PP
\fBExcludeClipRect\fP function excludes the specified rect \fB(left, top, right, bottom)\fP from the local clipping region of the DC.
.PP
\fBIncludeClipRect\fP function includes the specified rect \fB(left, top, right, bottom)\fP into the local clipping region of the DC.
.PP
\fBClipRectIntersect\fP function intersects the specified rect \fBprc\fP with the local clipping region of the DC.
.PP
\fBSelectClipRect\fP function sets the local clipping region of the DC to the rect pointed to by \fBprc\fP.
.PP
\fBSelectClipRegion\fP function sets the local clipping region of the DC to the region pointed to by \fBpRgn\fP.
.PP
\fBGetBoundsRect\fP function retrives the bounding rect of the current local clipping region of the DC. The struct pointed to by \fBpRect\fP will receive the bounding rect.
.PP
\fBPtVisible\fP function checks whether the point specified by \fBpPt\fP is visible, i.e. it is within the current local clipping region of the DC.
.PP
\fBRectVisible\fP function checks whether the rect specified by \fBpRect\fP is visible, i.e. it is intersected with the current local clipping region of the DC.
.SH "RETURN VALUE"
.PP
\fBPtVisible\fP and \fBRectVisible\fP functions return \fBTRUE\fP when the point or rect is visible, else return \fBFALSE\fP.
.SH "SEE ALSO"
.BR ClipRgnIntersect (3),
.BR SetClipRgn (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

118
doc/man3/miniguiDTI.3
View File

@@ -1,118 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "DTI" "3" "July 2000" "MiniGUI"
.SH "NAME"
DTI \- the desktop interfaces of MiniGUI
.SH "SYNOPSIS"
.B #include <minigui/minigui.h>
.PP
.BI "void GUIAPI CustomizeDesktopMenu" "(HMENU hDesktopMenu, int iPos);"
.br
.BI "int GUIAPI CustomDesktopCommand" "(int id);"
.br
.BI "void GUIAPI OpenAboutDialog" "(void);"
.br
.SH "DESCRIPTION"
.PP
\fBCustomizeDesktopMenu\fP function will be called automatically by MiniGUI when you click right button on MiniGUI's desktop.
.PP
\fBCustomDesktopCommand\fP function will be called automatically by MiniGUI when you choose command on MiniGUI's desktop menu.
.PP
\fBOpenAboutDialog\fP function tells desktop to open an \fBAbout MiniGUI...\fP dialog.
.SH "NOTES"
You should implemented \fBCustomizeDesktopMenu, CustumDesktopCommand\fP functions by yourself.
However, there is a \fBdti.c\fP file, which defines above functions as default actions. You can use these functions in your own \fBdti.c\fP by including this file in your \fBdti.c\fP file, as follows:
.PP
.nf
#include <minigui/dti.c>
.fi
.PP
Or you can use macros to disable the default functions and define your own instances:
.PP
.nf
// Use macro to disable system defined
// CustomizeDesktopMenu and CustomDesktopCommand functions
#define DONT_USE_SYS_CUSTOMIZEDESKTOPMENU
#include <minigui/dti.c>
// Define your own instance here.
void CustomizeDesktopMenu (HMENU hmnu, int iPos)
{
...
}
int CustomDesktopCommand (int id)
{
...
return 0;
}
.fi
.SH "SAMPLE"
This sample uses \fBCustomizeDesktopMenu\fP function to append a menu item at the desktop menu, and then uses \fBCustomDesktopCommand\fP to response the select of the appended menu item and open a Virtual Console window:
.PP
.nf
#define DONT_USE_SYS_CUSTOMIZEDESKTOPMENU
#include <minigui/dti.c>
#define IDC_DTI_ABOUT (IDM_DTI_FIRST + 1)
#define IDC_DTI_NEWVC (IDM_DTI_FIRST + 2)
void CustomizeDesktopMenu (HMENU hmnu, int iPos)
{
MENUITEMINFO mii;
memset (&mii, 0, sizeof(MENUITEMINFO));
mii.type = MFT_STRING;
mii.id = IDC_DTI_ABOUT;
mii.typedata = (DWORD)"About MiniGUI...";
mii.hsubmenu = 0;
InsertMenuItem (hmnu, iPos, TRUE, &mii);
mii.type = MFT_STRING;
mii.id = IDC_DTI_NEWVC;
mii.typedata = (DWORD)"New Virtual Console";
mii.hsubmenu = 0;
InsertMenuItem (hmnu, iPos + 1, TRUE, &mii);
}
int CustomDesktopCommand (int id)
{
if (id == IDC_DTI_ABOUT)
OpenAboutDialog ();
else if (id == IDC_DTI_NEWVC)
NewVirtualConsole (NULL);
return 0;
}
.fi
.SH "SEE ALSO"
.BR miniguiInit "(3), " miniguiMain (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

124
doc/man3/miniguiDialogBox.3
View File

@@ -1,124 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "DialogBox" "3" "August 2000" "MiniGUI"
.SH "NAME"
DialogBox \- DialogBox Support Functions.
.SH "SYNOPSIS"
.B #include <minigui/window.h>
.br
.PP
.BI "HWND GUIAPI CreateMainWindowIndirect" "(PDLGTEMPLATE pDlgTemplate, HWND hOwner, WNDPROC WndProc);"
.br
.BI "BOOL GUIAPI DestroyMainWindowIndirect" "(HWND hMainWin);"
.br
.BI "int GUIAPI DialogBoxIndirectParam" "(PDLGTEMPLATE pDlgTemplate, HWND hOwner, WNDPROC DlgProc, LPARAM lParam);"
.br
.BI "BOOL GUIAPI EndDialog" "(HWND hDlg, int endCode);"
.br
.BI "void GUIAPI DestroyAllControls" "(HWND hDlg);"
.br
.BI "int GUIAPI DefaultDialogProc" "(HWND hWnd, int message, WPARAM wParam, LPARAM lParam);"
.br
.BI "HWND GUIAPI GetDlgDefPushButton" "(HWND hWnd);"
.br
.BI "int GUIAPI GetDlgCtrlID" "(HWND hwndCtl);"
.br
.BI "HWND GUIAPI GetDlgItem" "(HWND hDlg, int nIDDlgItem);"
.br
.BI "UINT GUIAPI GetDlgItemInt" "(HWND hDlg, int nIDDlgItem, BOOL *lpTranslated, BOOL bSigned);"
.br
.BI "int GUIAPI GetDlgItemText" "(HWND hDlg, int nIDDlgItem, char* lpString, int nMaxCount);"
.br
.BI "char* GUIAPI GetDlgItemText2" "(HWND hDlg, int id, int* lenPtr);"
.br
.BI "HWND GUIAPI GetNextDlgGroupItem" "(HWND hDlg, HWND hCtl, BOOL bPrevious);"
.br
.BI "HWND GUIAPI GetNextDlgTabItem" "(HWND hDlg, HWND hCtl, BOOL bPrevious);"
.br
.BI "int GUIAPI SendDlgItemMessage" "( HWND hDlg, int nIDDlgItem, int message, WPARAM wParam, LPARAM lParam);"
.br
.BI "BOOL GUIAPI SetDlgItemInt" "(HWND hDlg, int nIDDlgItem, UINT uValue, BOOL bSigned);"
.br
.BI " BOOL GUIAPI SetDlgItemText" "(HWND hDlg, int nIDDlgItem, const char* lpString);"
.br
.BI "void GUIAPI CheckDlgButton" "(HWND hDlg, int nIDDlgItem, int nCheck);"
.br
.BI "void GUIAPI CheckRadioButton" "(HWND hDlg, int idFirstButton, int idLastButton, int idCheckButton);"
.br
.BI "int GUIAPI IsDlgButtonChecked" "(HWND hDlg, int idButton);"
.SH "DESCRIPTION"
.PP
\fBCreateMainWindowIndirect\fP function creates a dialog window specified by \fBpDlgTemplate\fP.
.PP
\fBDestroyMainWindowIndirect\fP function destroys the window created by \fBCreateMainWindowIndirect\fP.
.PP
\fBDialogBoxIndirectParam\fP function creates a modal dialog box from a dialog box template in memory. Before displaying the dialog box, the function passes an application-defined value to the dialog box procedure as the \fBlParam\fP parameter of the \fBWM_INITDIALOG\fP message. An application can use this value to initialize dialog box controls.
.PP
\fBEndDialog\fP function destroys a modal dialog box, causing the system to end any processing for the dialog box.
.PP
\fBDestroyAllControls\fP function destroys all the controls in the dialog box.
.PP
\fBDefaultDialogProc\fP function is the default dialog box message handler.
.PP
\fBGetDlgDefPushButton\fP function gets the default push button in the window specified by hWnd.
.PP
\fBGetDlgCtrlID\fP function returns the identifier of the specified control.
.PP
\fBGetDlgItem\fP function retrieves the handle of a control in the specified dialog box.
.PP
\fBGetDlgItemInt\fP function translates the text of a specified control in a dialog box into an integer value.
.PP
\fBGetDlgItemText\fP function retrieves the title or text associated with a control in a dialog box.
.PP
\fBGetDlgItemText2\fP function is similiar to \fBGetDlgItemText\fP function.But it allocates memory for the text.
.PP
\fBGetNextDlgGroupItem\fP function retrieves the handle of the first control in a group of controls that precedes (or follows) the specified control in a dialog box.
.PP
\fBGetNextDlgTabItem\fP function retrieves the handle of the first control that has the \fBWS_TABSTOP\fP style that precedes (or follows) the specified control.
.PP
\fBSendDlgItemMessage\fP function sends a message to the specified control in a dialog box.
.PP
\fBSetDlgItemInt\fP function sets the text of a control in a dialog box to the string representation of a specified integer value.
.PP
\fBSetDlgItemText\fP function sets the title or text of a control in a dialog box.
.PP
\fBCheckDlgButton\fP function changes the check status of a button control.
.PP
\fBCheckRadioButton\fP function adds a check mark to (checks) a specified radio button in a group and removes a check mark from (clears) all other radio buttons in the group.
.PP
\fBIsDlgButtonChecked\fP function determines whether a button control has a check mark next to it or whether a three-state button control is grayed, checked, or neither.
.SH "RETURN VALUE"
.PP
.SH "NOTE"
.PP
.SH "SEE ALSO"
.SH "AUTHOR"
.PP
This manual page was edited by Song Lixin <zjujoe@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

141
doc/man3/miniguiDrawing.3
View File

@@ -1,141 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "Drawing" "3" "August 2000" "MiniGUI"
.SH "NAME"
Drawing \- general drawing functions.
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.br
.PP
.BI "gal_pixel GUIAPI GetPixel" "(HDC hdc, int x, int y);"
.br
.BI "void GUIAPI SetPixel" "(HDC hdc, int x, int y, gal_pixel c);"
.br
.BI "void GUIAPI GetPixelRGB" "(HDC hdc, int x, int y, int* r, int* g, int* b);"
.br
.BI "void GUIAPI SetPixelRGB" "(HDC hdc, int x, int y, int r, int g, int b);"
.br
.BI "gal_pixel GUIAPI RGB2Pixel" "(HDC hdc, int r, int g, int b);"
.br
.BI "void GUIAPI MoveTo" "(HDC hdc, int x, int y);"
.br
.BI "void GUIAPI LineTo" "(HDC hdc, int x, int y);"
.br
.BI "void GUIAPI Circle" "(HDC hdc, int x, int y, int r);"
.br
.BI "void GUIAPI Rectangle" "(HDC hdc, int x0, int y0, int x1, int y1);"
.br
.BI "void GUIAPI FocusRect" "(HDC hdc, int x0, int y0, int x1, int y1);"
.SH "DESCRIPTION"
.PP
\fBGetPixel\fP function gets pixel at the position \fB(x, y)\fP on the DC \fBhdc\fP.
.PP
\fBSetPixel\fP function sets pixel at the position \fB(x, y)\fP on the DC. You can use pre-defined standard pixel values:
.PP
.I PIXEL_black
black
.br
.I PIXEL_darkred
dark red
.br
.I PIXEL_darkgreen
dark green
.br
.I PIXEL_darkyellow
dark yellow
.br
.I PIXEL_darkblue
dark blue
.br
.I PIXEL_darkmagenta
dark magenta
.br
.I PIXEL_darkcyan
dark cyan
.br
.I PIXEL_lightgray
light gray
.br
.I PIXEL_darkgray
dark gray
.br
.I PIXEL_red
red
.br
.I PIXEL_green
green
.br
.I PIXEL_yellow
yellow
.br
.I PIXEL_blue
blue
.br
.I PIXEL_magenta
magenta
.br
.I PIXEL_cyan
cyan
.br
.I PIXEL_lightwhite
light white
.PP
\fBGetPixelRGB\fP function gets pixel's RGB values at the position \fB(x, y)\fP on the DC.
.PP
\fBSetPixelRGB\fP function sets pixle at the position \fB(x, y)\fP with RGB value on the DC.
.PP
\fBRGB2Pixel\fP function converts RGB value to pixel value. Note that the range of a RGB value is 0~0xFF.
.PP
\fBMoveTo\fP function moves the current position to \fB(x, y)\fP.
.PP
\fBLineTo\fP function draws a line from the current position to \fB(x, y)\fP with current pen color. You can use \fBMoveTo\fP tochange the current position.
.PP
\fBCircle\fP function draws a circle with current pen color. The center of the circle is at \fB(x, y)\fP, and the radius is \fBr\fP.
.PP
\fBRectangle\fP function draws a rectangle with current pen color. The upper-left corner of the rectangle is \fB(x0, y0)\fP, and the lower-right corner of the rectangle is \fB(x1, y1)\fP.
.PP
\fBFocusRect\fP function draws a focus rectanglt with current pen color. The upper-left corner of the rectangle is \fB(x0, y0)\fP, and the lower-right corner of the rectangle is \fB(x1, y1)\fP. Focus rectangle is composed with dashed lines.
.PP
All coordinates are in logical units.
.SH "RETURN VALUE"
.PP
The \fBGet...\fP functions return the value you want.
.SH "NOTE"
.PP
Internally, MiniGUI uses pixel value to present a point in DC. You can use \fBRGB2Pixel\fP to convert RGB value to pixel value. Note that the range of a RGB value is 0~0xFF in MiniGUI.
.SH "SEE ALSO"
.BR SetMapMode (3)
.BR SetPenColor (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

83
doc/man3/miniguiEtcFile.3
View File

@@ -1,83 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "EtcFile" "3" "July 2000" "MiniGUI"
.SH "NAME"
EtcFile \- get/set values from/to MiniGUI configuration (etc) file.
.SH "SYNOPSIS"
.B #include <minigui/minigui.h>
.PP
.BI "extern char ETCFILEPATH [];"
.PP
.BI "int GUIAPI GetValueFromEtcFile" "(const char* pEtcFile, const char* pSection, const char* pKey, char* pValue, int iLen);"
.br
.BI "int GUIAPI GetIntValueFromEtcFile" "(const char* pEtcFile, const char* pSection, const char* pKey, int* value);"
.br
.BI "int GUIAPI SetValueToEtcFile" "(const char* pEtcFile, const char* pSection, const char* pKey, char* pValue);"
.br
.SH "DESCRIPTION"
.PP
In MiniGUI, you can get specific values from \fBetc\fP files using \fBGetValueFromEtcFile\fP and \fBGetIntValueFromEtcFile\fP. Etc files are text configuration files with same format as Windows INI files. A etc file has following simple format:
.PP
.nf
[section0]
key0=value0
key1=value1
[section1]
key0=value0
key1=value1
.fi
.PP
As you have seen, etc files are composed by \fBsections\fP. Every \fBvalue\fP in etc file is refrenced by \fBkey\fP. You should specify section name and key name to find a specific value.
.PP
\fBGetValueFromEtcFile\fP function gets a value (a string) with \fBpKey\fP key from \fBpSection\fP section in \fBpEtcFile\fP file, and store the value in buffer \fBpValue\fP with \fBiLen\fP length.
.PP
\fBGetIntValueFromEtcFile\fP function gets a integer with \fBpKey\fP key from \fBpSection\fP section in \fBpEtcFile\fP file, and store the value in the buffer \fBvalue\fP.
.PP
\fBSetValueToEtcFile\fP function sets the value of \fBpKey\fP key in \fBpSection\fP section in \fBpEtcFile\fP file as \fBpValue\fP. This function will create etc file, section or key when missing the specified file, section or key.
.PP
The two functions return zero if suceess, or else will return nonzero.
.SH "RETURN VALUE"
.PP
If the return value is less than zero, there is an error occured. The returned value indicates the error type:
.IP \fBETC_FILENOTFOUND\fP
The specified etc file not found or file open error.
.IP \fBETC_SECTIONNOTFOUND\fP
The specified section not found in the etc file.
.IP \fBETC_KEYNOTFOUND\fP
The specified key not found in the section.
.IP \fBETC_TMPFILEFAILED\fP
Temporary file operations error when setting value to etc file.
.IP \fBETC_FILEIOFAILED\fP
Error in file I/O.
.SH "NOTES"
.PP
MiniGUI use /etc/MiniGUI.cfg as its configuration file. However, you can put your own configuration in /usr/local/etc/MiniGUI.cfg or ~/.MiniGUI.cfg to override the configurations in /etc/MiniGUI.cfg. The global variable \fBETCFILEPATH\fP store the actual MiniGUI.cfg file path used by MiniGUI.
.PP
The maximal length of line in etc file are \fBETC_MAXLINE\fP, which is definded 1024 as default.
.SH "SEE ALSO"
.BR MiniGUI.cfg "(5)"
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

48
doc/man3/miniguiFixStr.3
View File

@@ -1,48 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "FixStr" "3" "July 2000" "MiniGUI"
.SH "NAME"
FixStr \- the functions allocating/freeing length-fixed string in MiniGUI.
.SH "SYNOPSIS"
.B #include <minigui/minigui.h>
.PP
.BI "char* GUIAPI FixStrAlloc" "(int len);"
.br
.BI "void GUIAPI FreeFixStr" "(char* str);"
.SH "DESCRIPTION"
.PP
\fBFixStrAlloc\fP function allocates memory in MiniGUI's length-fixed string heap. The result memory should accommondate a null-terminated string with length of \fBlen\fP, that is, the memory is with \fB(len + 1)\fP long.
.PP
\fBFreeFixStr\fP function frees the memory allocated by \fBFixStrAlloc\fP.
.SH "RETURN VALUE"
\fBFixStrAlloc\fP function returns the pointer to the memory allocated. When error occurred, this function will return NULL.
.SH "NOTES"
There are many length-fixed strings in MiniGUI, such as captions of windows. MiniGUI has an internal heap for allocating/freeing length-fixed strings efficiently. You can allocate memory from this heap by using \fBFixStrAlloc\fP. However, you should avoid doing \fBstrcat\fP on the memory allocated by \fBFixStrAlloc\fP.
.PP
When there is no free space in MiniGUI's internal heap, MiniGUI will try to allocate memory from system heap by using \fBmalloc\fP. You can safely free the memory actually returned by \fBmalloc\fP with \fBFreeFixStr\fP.
.SH "SEE ALSO"
.BR strcat "(3), " malloc "(3), " free (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

1245
doc/man3/miniguiFunctions.3
View File

File diff suppressed because it is too large Load Diff

67
doc/man3/miniguiGetSysText.3
View File

@@ -1,67 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "GetSysText" "3" "July 2000" "MiniGUI"
.SH "NAME"
GetSysText \- get MiniGUI system text in i18n applications.
.SH "SYNOPSIS"
.B #include <minigui/minigui.h>
.PP
.BI "extern const char* SysText [];"
.PP
.BI "const char* GetSysText" "(const char* text);"
.SH "DESCRIPTION"
.PP
When MiniGUI display some system messages, it will call \fBGetSysText\fP function to translate system text. You can use \fBgettext\fP to return the text. Global variable \fBSysText\fP contains all text used by MiniGUI.
.PP
You must implement \fBGetSysText\fP by yourself. However, there is a \fBdti.c\fP file, which defines the function as default actions. You can use these functions in your own \fBdti.c\fP by including this file in your \fBdti.c\fP file, as follows:
.PP
.nf
#include <minigui/dti.c>
.fi
.PP
Or you can use macros to disable the default functions and define your own instances:
.PP
.nf
// Use macro to disable system defined GetSysText
#define DONT_USE_SYS_GETSYSTEXT
#include <minigui/dti.c>
// Define your own instance here.
const char* GetSysText (const char* text)
{
return gettext (text);
}
.fi
.SH "SEE ALSO"
.BR gettext (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

36
doc/man3/miniguiHook.3
View File

@@ -1,36 +0,0 @@
.TH "Hook" "3" "August 2000" "MiniGUI"
.SH "NAME"
Hook \- hook function in MiniGUI.
.SH "SYNOPSIS"
.B #include <minigui/window.h>
.br
.PP
.BI "HHOOK GUIAPI RegisterKeyMsgHook" "(HWND hWnd, KEYMSGHOOK hook);"
.br
.BI "HHOOK GUIAPI RegisterMouseMsgHook" "(HWND hWnd, MOUSEMSGHOOK hook);"
.br
.BI "int GUIAPI UnregisterHook" "(HHOOK hHook);"
.SH "DESCRIPTION"
.PP
\fBRegisterKeyMsgHook\fP function registers a key message hook pointed to by \fBhook\fP and associates with the main window \fBhwnd\fP. This function returns the handle to the registered hook.
.PP
\fBRegisterMouseMsgHook\fP function registers a mouse message hook pointed to by \fBhook\fP and associate with the main window \fBhwnd\fP. This function returns the handle to the registered hook.
.PP
\fBUnregisterHook\fP function removes the key or mouse message hook specified by the handle of \fBhook\fP.
.SH "RETURN VALUE"
.PP
.SH "NOTE"
.PP
.SH "SEE ALSO"
.SH "AUTHOR"
.PP
This manual page was edited by Kevin <kevin@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

68
doc/man3/miniguiIME.3
View File

@@ -1,68 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "IMEHandler" "3" "August 2000" "MiniGUI"
.SH "NAME"
IMEHandler \- IME related functions.
.SH "SYNOPSIS"
.B #include <minigui/window.h>
.br
.PP
.BI "int IMEWinProc" "(HWND hWnd, int message, WPARAM wParam, LPARAM lParam);"
.br
.BI "void* IMEWindow" "(void* data);"
.br
.BI "int GUIAPI RegisterIMEWindow" "(HWND hWnd);"
.br
.BI "int GUIAPI UnregisterIMEWindow" "(HWND hWnd);"
.br
.BI "int GUIAPI GetIMEStatus" "(int StatusCode);"
.br
.BI "int GUIAPI SetIMEStatus" "(int StatusCode, int Value);"
.SH "DESCRIPTION"
.PP
\fBIMEWinProc\fP function is the message handling function of the IME window.
.PP
\fBIMEWindow\fP function Creates an IME window.
.PP
\fBRegisterIMEWindow\fP function registers an IME window.After that,the keyboard input will be sent to IME window first.\fBNote\fP,Only one IME window can be registered.
.PP
\fBUnregisterIMEWindow\fP function undoes the effect of \fBRegisterIMEWindow\fP.
.PP
\fBGetIMEStatus\fP function retrieves some status of the IME window. Parameter \fBStatusCode\fP specifies which state to retrieve.
.PP
\fBSetIMEStatus\fP function sets some status of the IME window. Parameter StatusCode specify which state to set.
.SH "RETURN VALUE"
.PP
.SH "NOTE"
.PP
.SH "SEE ALSO"
.SH "AUTHOR"
.PP
This manual page was edited by Song Lixin <zjujoe@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

60
doc/man3/miniguiIcon.3
View File

@@ -1,60 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "Icon" "3" "August 2000" "MiniGUI"
.SH "NAME"
Icon \- Icon operations in MiniGUI.
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.br
.PP
.BI "HICON GUIAPI LoadIconFromFile" "(HDC hdc, const char* filename, int which);"
.br
.BI "HICON GUIAPI CreateIcon" "(HDC hdc, int w, int h, const BYTE* AndBits, const BYTE* XorBits, int colornum);"
.br
.BI "BOOL GUIAPI DestroyIcon" "(HICON hicon);"
.br
.BI "void GUIAPI DrawIcon" "(HDC hdc, int x, int y, int w, int h, HICON hicon);"
.SH "DESCRIPTION"
.PP
\fBLoadIconFromFile\fP function load icon from a Windows ICO file named \fBfilename\fP and creates an icon object. This function can load mono- and 16-color icons. Some Windows ICO file contain two icons in different sizes. You can tell this function to load which icon though \fBwhich\fP, \fB0\fP for the first icon, and \fB1\fP for the second icon. Generally, the later icon is the larger icon.
.PP
\fBCreateIcon\fP function creates an icon object from the memory.
.PP
\fBDestroyIcon\fP function destroys the icon object \fBhicon\fP.
.PP
\fBDrawIcon\fP function draws the icon \fBhicon\fP in a box specified by \fB(x, y, w, h)f\fP.
.SH "RETURN VALUE"
.PP
The functions creating icon return the handle to the created icon. They will return 0 when error occurred.
.SH "SEE ALSO"
.BR LoadBitmap (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

77
doc/man3/miniguiInit.3
View File

@@ -1,77 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "Init" "3" "July 2000" "MiniGUI"
.SH "NAME"
Init \- Initialization and termination of MiniGUI.
.SH "SYNOPSIS"
.B #include <minigui/minigui.h>
.PP
.BI "BOOL GUIAPI InitGUI" "(void);"
.br
.BI "void GUIAPI TerminateGUI" "(int rcByGUI);"
.br
.BI "void GUIAPI MiniGUIPanic" "(int exitcode);"
.br
.BI "void GUIAPI SuspendGUI" "(void);"
.br
.BI "BOOL GUIAPI ResumeGUI" "(void);"
.br
.SH "DESCRIPTION"
.PP
\fBInitGUI\fP function initializes MiniGUI support system. It will allocate and load resources used by MiniGUI, create threads which act as mini servers, and more important, set vedio mode according to MiniGUI.cfg file.
.PP
This function will be called automatically by \fBmain\fP function. Applications should avoid calling this function directly. \fBmain\fP function has been implemented in libminigui as following:
.PP
.nf
int main(int args, const char* agr[])
{
int iRet = 0;
if (!PreInitGUI (args, agr, &iRet))
return iRet;
if (!InitGUI()) return -1;
iRet = MiniGUIMain (args, agr);
TerminateGUI (iRet);
iRet = PostTerminateGUI (args, agr, iRet);
return iRet;
}
.fi
.PP
\fBTerminateGUI\fP function is normally called by application's main function. According to the returned value of \fBMiniGUIMain\fR function, \fBTerminateGUI\fR either suspends calling thread and waits system threads, or just kills all threads except calling thread, frees resources used by MiniGUI, sets vedio card back to text mode, and then terminates MiniGUI application.
.PP
\fBrcByGUI\fR is the return value of \fBMiniGUIMain\fP function. If \fBrcByGUI\fR >= 0, calling thread will suspend; if \fBrcByGUI\fR < 0, application will terminate.
.PP
This function will be called automatically by \fBmain\fP function. Applications should avoid calling this function directly.
.PP
\fBMiniGUIPanic\fP function will abnormally terminate MiniGUI application, so it be not recommended to use.
.PP
You can use \fBSuspendGUI\fP function to suspend the reponse of MiniGUI to user, then you must call the function named \fBResumeGUI\fP to restore the response.
.PP
If you call the function \fBSuspendGUI\fP to suspend the response of MiniGUI to user, you need call \fBResumeGUI\fP function to restore the action of MiniGUI. In fact, the function \fBResumeGUI\fP performs the same things as the function \fBInitGUI\fP does, except that it don't save the original termio.
.SH "SEE ALSO"
.BR miniguiMain "(3)"
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

117
doc/man3/miniguiLite.3
View File

@@ -1,117 +0,0 @@
.\" This manpage is Copyright (C) 2000, 2001 Wei Yongming
.\" 2000, 2001 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "Lite" "3" "Feb. 2001" "MiniGUI"
.SH "NAME"
Lite \- MiniGUI-Lite specific functions.
.SH "SYNOPSIS"
.B #include <minigui/minigui.h>
.br
.PP
.BI "BOOL GUIAPI SetDesktopRect" "(int lx, int ty, int rx, int by);"
.br
.BI "void GUIAPI GetDesktopRect" "(int* lx, int* ty, int* rx, int* by);"
.br
.BI "BOOL GUIAPI ServerStartup" "(void);"
.br
.BI "BOOL GUIAPI SetClientScreen" "(int lx, int ty, int rx, int by);"
.br
.BI "BOOL GUIAPI OnlyMeCanDraw" "(void);"
.br
.BI "BOOL GUIAPI ClientCanDrawNowEx" "(BOOL bRepaint);"
.br
.BI "BOOL GUIAPI SetTopMostClient" "(int cli);"
.br
.BI "int GUIAPI GetClientByPID" "(int pid);"
.br
.BI "int cli_request" "(PREQUEST request, void* result, int len_rslt);"
.br
.BI "BOOL GUIAPI RegisterRequestHandler" "(int req_id, REQ_HANDLER your_handler);"
.br
.BI "REQ_HANDLER GUIAPI GetRequestHandler" "(int req_id);"
.br
.BI "int get_sock_fd2srv" "(void);"
.br
.BI "int sock_write" "(int fd, const void* buff, int count);"
.br
.BI "int sock_read" "(int fd, void* buff, int count);"
.br
.BI "BOOL GUIAPI RegisterListenFD" "(int fd, int type, HWND hwnd, void* context);"
.br
.BI "BOOL GUIAPI UnregisterListenFD" "(int fd);"
.PP
.B #include <minigui/window.h>
.PP
.BI "BOOL GUIAPI Send2TopMostClient" "(int iMsg, WPARAM wParam, LPARAM lParam);"
.SH "DESCRIPTION"
.PP
\fBSetDesktopRect\fP function sets the desktop rect of server or client, must called before create any window.
.PP
\fBGetDesktopRect\fP function gets the desktop rect of server or client.
.PP
\fBServerStartup\fP: Call this function to be a server of MiniGUI-Lite. And the first argument of command line must be `mginit'.
.PP
\fBSetClientScreen\fP: Call this function by server to set the screen of clients.
.PP
\fBOnlyMeCanDraw\fP: Call this function by server to disable the screen output of clients.
.PP
\fBClientCanDrawNowEx\fP: Call this function by server to tell the topmost client can draw to screen and/or refresh its content.
.PP
\fBSetTopMostClient\fP: Call this function by server to set the topmost client.
.PP
\fBGetClientByPID\fP: Call this function by server to get the client id from PID of client.
.PP
\fBcli_request\fP: Call this function by clients to send a request to server.
.PP
\fBRegisterRequestHandler\fP: Call this function by server to register a request handler.
.PP
\fBGetRequestHandler\fP: Get the request handler of specified request id.
.PP
\fBget_sock_fd2srv\fP: Call this function by clients to get the socket descriptor connected to server.
.PP
\fBsock_write\fP: Helper functions for socket writing operation.
.PP
\fBsock_read\fP: Helper functions for socket writing operation.
.PP
\fBSend2TopMostClient\fP function send a message to the topmost client.
.PP
\fBRegisterListenFD\fP: Call this function to register a listen fd to MiniGUI. When there is a read event on this fd, MiniGUI will post a MSG_FDEVENT message with wParam being equal to MAKELONG (fd, type) to the target window.
.PP
\fBUnregisterListenFD\fP: Call this function to unregister the fd registered by \fBRegisterListenFD\fP.
.SH "RETURN VALUE"
.PP
.SH "NOTE"
.PP
.SH "SEE ALSO"
.SH "AUTHOR"
.PP
This manual page was edited by Wei Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

66
doc/man3/miniguiLogFont.3
View File

@@ -1,66 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "LogFont" "3" "August 2000" "MiniGUI"
.SH "NAME"
LogFont \- Logical fonts in MiniGUI.
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.br
.PP
.BI "PLOGFONT GUIAPI CreateLogFont" "(const char* type, const char* family, const char* charset, char weight, char slant, char set_width, char spacing, char underline, char struckout, int size, int rotation);"
.br
.BI "PLOGFONT GUIAPI CreateLogFontIndirect" "(PLOGFONT logfont);"
.br
.BI "void GUIAPI DestroyLogFont" "(PLOGFONT log_font);"
.br
.BI "PLOGFONT GUIAPI GetSystemFont" "(int font_id);"
.br
.BI "PLOGFONT GUIAPI GetCurFont" "(HDC hdc);"
.br
.BI "PLOGFONT GUIAPI SelectFont" "(HDC hdc, PLOGFONT log_font);"
.SH "DESCRIPTION"
.PP
\fBCreateLogFont\fP function creates a logical font. Note that the size of logical font may be different from the size expected, and you can specify \fBrotation\fP only for TrueType font. The \fBrotation\fP is in units of tenth degrees.
.PP
\fBCreateLogFontIndirect\fP function creates a logical font. Note that the size of logical font may be different from the size expected.
.PP
\fBDestroyLogFont\fP function destroys a logical font \fBlog_font\fP.
.PP
\fBGetSystemFont\fP function retrives the system logical font. \fBfont_id\fP is the identifier of system font. So far, you can only use \fBSYSLOGFONT_DEFAULT\fP as the value.
.PP
\fBGetCurFont\fP function retrives the current logical font in the DC. When initializes a DC, MiniGUI will set system font as its default logical font.
.PP
\fBSelectFont\fP function selects a logical font into the DC. This function returns the handle to the old logical font.
.SH "SEE ALSO"
.BR TextOut (3),
.BR GetSysCharWidth (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

125
doc/man3/miniguiMain.3
View File

@@ -1,125 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "Main" "3" "July 2000" "MiniGUI"
.SH "NAME"
Main \- the entrance of MiniGUI based program
.SH "SYNOPSIS"
.B #include <minigui/minigui.h>
.PP
.BI "int MiniGUIMain" "(int args, const char* arg[]);"
.br
.BI "BOOL GUIAPI PreInitGUI" "(int args, const char* arg[], int* retp);"
.br
.BI "int GUIAPI PostTerminateGUI" "(int args, const char* arg[], int rcByGUI);"
.br
.BI "void GUIAPI ExitGUISafely" "(int exitcode);"
.br
.SH "DESCRIPTION"
.PP
Usually, \fBMiniGUIMain\fP function is the entrance of each MiniGUI-based program. In this function, you can create one or more threads for specified main windows. Here is a deliberate design, it is very simple:
.PP
.nf
int MiniGUIMain(int args, const char* arg[])
{
pthread_t thread1, thread2;
CreateThreadForMainWindow(&thread1, NULL, MainWin1, 0);
CreateThreadForMainWindow(&thread2, NULL, MainWin2, 0);
return 0;
}
.fi
.PP
Here we call function \fBCreateThreadForMainWindow\fR to create a thread for the main window. This function will return zero if success, or else it will return nonzero value.
.PP
MiniGUI will call \fBPreInitGUI\fP automaticlly in \fBmain\fP function. Applications should avoid calling this function directly. \fBmain\fP function has been implemented in libminigui as following:
.PP
.nf
int main(int args, char* agr[])
{
int iRet = 0;
if (!PreInitGUI (args, agr, &iRet))
return iRet;
if (!InitGUI()) return -1;
iRet = MiniGUIMain (args, agr);
TerminateGUI (iRet);
iRet = PostTerminateGUI (args, agr, iRet);
return iRet;
}
.fi
.PP
You must implemente \fBPreInitGUI\fR function by yourself, so you have a chance to do something before starting MiniGUI. If the return value is \fBTRUE\fR, the program will running on, else if the return value is \fBFALSE\fR, the program will terminate.
.PP
Before terminating the application, \fBmain\fR function will call \fBPostTerminateGUI\fR function. The return value of \fBPostTerminateGUI\fR is the exit code of program.
.PP
You must implemente \fBPostTerminateGUI\fR function by your own, so you have a chance to modify the exit code of the program.
.PP
\fBExitGUISafely\fP has been implemented as following:
.PP
.nf
void ExitGUISafely(int exitcode)
{
pthread_kill_other_threads_np();
TerminateLWEvents();
TerminateGDI();
exit(exitcode);
}
.fi
.PP
When the program exiting, it will transfer the value \fBexitcode\fP to the system shell.
.SH "NOTES"
You should implemented \fBPreInitGUI, PostTerminateGUI\fP functions by yourself. However, there is a \fBdti.c\fP file, which defines above functions as default actions. You can use these functions in your own \fBdti.c\fP by including this file in your \fBdti.c\fP file, as follows:
.PP
.nf
#include <minigui/dti.c>
.fi
.PP
Or you can use macros to disable the default functions and define your own instances:
.PP
.nf
// Use macro to disable system defined
// PreInitGUI functions
#define DONT_USE_SYS_PREINITGUI
#include <minigui/dti.c>
// Define your own instance here.
BOOL GUIAPI PreInitGUI (int args, const char* arg[], int* retp)
{
if (...)
return FALSE; // Terminate program immediately.
return TRUE; // Startup minigui normally.
}
.fi
.SH "SEE ALSO"
.BR miniguiMain "(3), " miniguiInit "(3), " miniguiDTI (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

326
doc/man3/miniguiMainWindow.3
View File

@@ -1,326 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "MainWindow" "3" "August 2000" "MiniGUI"
.SH "NAME"
MainWindow \- function about main window in MiniGUI.
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.PP
.BI "BOOL GUIAPI ExcludeWindowStyle" "(HWND hWnd, DWORD dwStyle);"
.br
.BI "BOOL GUIAPI IncludeWindowStyle" "(HWND hWnd, DWORD dwStyle);"
.br
.BI "HWND GUIAPI CreateMainWindow" "(PMAINWINCREATE pCreateStruct);"
.br
.BI "BOOL GUIAPI DestroyMainWindow" "(HWND hWnd);"
.br
.BI "int DefaultMainWinProc" "(HWND hWnd, int message, WPARAM wParam, LPARAM lParam);"
.br
.BI "int DefaultControlProc" "(HWND hWnd, int message, WPARAM wParam, LPARAM lParam);"
.br
.BI "void GUIAPI UpdateWindow" "(HWND hWnd, BOOL bErase);"
.br
.BI "BOOL GUIAPI ShowWindow" "(HWND hWnd, int iCmdShow);"
.br
.BI "BOOL GUIAPI EnableWindow" "(HWND hWnd, int fEnable);"
.br
.BI "BOOL GUIAPI IsWindowEnabled" "(HWND hWnd);"
.br
.BI "BOOL GUIAPI GetClientRect" "(HWND hWnd, PRECT prc);"
.br
.BI "int GUIAPI GetWindowBkColor" "(HWND hWnd);"
.br
.BI "HCURSOR GUIAPI GetWindowCursor" "(HWND hWnd);"
.br
.BI "HCURSOR GUIAPI SetWindowCursor" "(HWND hWnd, HCURSOR hNewCursor);"
.br
.BI "DWORD GUIAPI GetWindowStyle" "(HWND hWnd);"
.br
.BI "DWORD GUIAPI GetWindowExStyle" "(HWND hWnd);"
.br
.BI "DWORD GUIAPI GetWindowAdditionalData" "(HWND hWnd);"
.br
.BI "DWORD GUIAPI SetWindowAdditionalData" "(HWND hWnd, DWORD newData);"
.br
.BI "DWORD GUIAPI GetWindowAdditionalData2" "(HWND hWnd);"
.br
.BI "DWORD GUIAPI SetWindowAdditionalData2" "(HWND hWnd, DWORD newData);"
.br
.BI "DWORD GUIAPI GetWindowClassAdditionalData" "(HWND hWnd);"
.br
.BI "DWORD GUIAPI SetWindowClassAdditionalData" "(HWND hWnd, DWORD newData);"
.br
.BI "char* GUIAPI GetWindowCaption" "(HWND hWnd);"
.br
.BI "BOOL GUIAPI SetWindowCaption" "(HWND hWnd, char* spCaption);"
.br
.BI "BOOL GUIAPI InvalidateRect" "(HWND hWnd, const RECT* prc, BOOL bEraseBkgnd);"
.br
.BI "HDC GUIAPI BeginPaint" "(HWND hWnd);"
.br
.BI "void GUIAPI EndPaint" "(HWND hWnd, HDC hdc);"
.br
.BI "int GUIAPI ClientWidthToWindowWidth" "(DWORD dwStyle, int cw);"
.br
.BI "int GUIAPI ClientHeightToWindowHeight" "(DWORD dwStyle, int ch, BOOL hasMenu);"
.br
.BI "void GUIAPI ClientToScreen" "(HWND hWnd, int* x, int* y);"
.br
.BI "void GUIAPI ScreenToClient" "(HWND hWnd, int* x, int* y);"
.br
.BI "void GUIAPI WindowToScreen" "(HWND hWnd, int* x, int* y);"
.br
.BI "void GUIAPI ScreenToWindow" "(HWND hWnd, int* x, int* y);"
.br
.BI "BOOL GUIAPI IsMainWindow" "(HWND hWnd);"
.br
.BI "BOOL GUIAPI IsControl" "(HWND hWnd);"
.br
.BI "BOOL GUIAPI IsWindow" "(HWND hWnd);"
.br
.BI "HWND GUIAPI GetParent" "(HWND hWnd);"
.br
.BI "BOOL GUIAPI IsWindowVisible" "(HWND hWnd);"
.br
.BI "BOOL GUIAPI GetWindowRect" "(HWND hWnd, PRECT prc);"
.br
.BI "HWND GUIAPI GetHosting" "(HWND hWnd);"
.br
.BI "HWND GUIAPI GetFirstHosted" "(HWND hWnd);"
.br
.BI "HWND GUIAPI GetNextHosted" "(HWND hHosting, HWND hHosted);"
.br
.BI "int GUIAPI GetWindowTextLength" "(HWND hWnd);"
.br
.BI "int GUIAPI GetWindowText" "(HWND hWnd, char* spString, int nMaxLen);"
.br
.BI "BOOL GUIAPI SetWindowText" "(HWND hWnd, char* spString);"
.br
.BI "HWND GUIAPI SetFocus" "(HWND hWnd);"
.br
.BI "HWND GUIAPI GetFocus" "(void);"
.br
.BI "HWND GUIAPI GetFocusChild" "(HWND hMainWnd);"
.br
.BI "HWND GUIAPI SetActiveWindow" "(HWND hMainWnd);"
.br
.BI "HWND GUIAPI GetActiveWindow" "(void);"
.br
.BI "HWND GUIAPI SetCapture" "(HWND hMainWnd);"
.br
.BI "HWND GUIAPI GetCapture" "(void);"
.br
.BI "void GUIAPI ReleaseCapture" "(void);"
.br
.BI "BOOL GUIAPI MoveWindow" "(HWND hWnd, int x, int y, int w, int h, BOOL fPaint);"
.br
.BI "void GUIAPI ScrollWindow" "(HWND hWnd, int iOffx, int iOffy, const RECT* rc1, const RECT* rc2);"
.br
.BI "BOOL GUIAPI EnableScrollBar" "(HWND hWnd, int iSBar, BOOL bEnable);"
.br
.BI "BOOL GUIAPI GetScrollPos" "(HWND hWnd, int iSBar, int* pPos);"
.br
.BI "BOOL GUIAPI GetScrollRange" "(HWND hWnd, int iSBar, int* pMinPos, int* pMaxPos);"
.br
.BI "BOOL GUIAPI SetScrollPos" "(HWND hWnd, int iSBar, int iNewPos);"
.br
.BI "BOOL GUIAPI SetScrollRange" "(HWND hWnd, int iSBar, int iMinPos, int iMaxPos);"
.br
.BI "BOOL GUIAPI ShowScrollBar" "(HWND hWnd, int iSBar, BOOL bShow);"
.br
.BI "BOOL GUIAPI SetScrollInfo" "(HWND, int, LPCSCROLLINFO, BOOL);"
.br
.BI "BOOL GUIAPI GetScrollInfo" "(HWND, int, LPSCROLLINFO);"
.br
.BI "HWND GUIAPI GetMainWindowHandle" "(HWND hWnd);"
.br
.BI "int GUIAPI CreateThreadForMainWindow" "(pthread_t* thread, pthread_attr_t* attr, void * (*start_routine)(void *), void * arg);"
.br
.BI "pthread_t GUIAPI GetMainWinThread" "(HWND hMainWnd);"
.br
.BI "void GUIAPI MainWindowThreadCleanup" "(HWND hMainWnd);"
.br
.BI "int GUIAPI WaitMainWindowClose" "(HWND hWnd, void** returnval);"
.br
.BI "BOOL GUIAPI LoadSystemBitmap" "(PBITMAP pBitmap, const char* szItemName);"
.br
.BI "HICON GUIAPI LoadSystemIcon" "(const char* szItemName, int which);"
.SH "DESCRIPTION"
.PP
\fBExcludeWindowStyle\fP function removes one window style indicate by parameter \fBdwStyle\fP style set.
.PP
\fBIncludeWindowStyle\fP function adds window style indicate by parameter \fBdwStyle\fP into style set.
.PP
\fBCreateMainWindow\fP function creates main window and initialize with parameter \fBpCreateStruct\fP.
.PP
\fBDestroyMainWindow\fP function destroys main window and release relative resource.
.PP
\fBDefaultMainWinProc\fP function handles window default message.
.PP
\fBDefaultControlProc\fP function handles control default messgae.
.PP
\fBUpdateWindow\fP function updates the client area of the specified window by sending a WM_PAINT message to the window.
.PP
\fBShowWindow\fP function sets the specified window's show state with one in (SW_SHOWNORMAL,SW_SHOW,SW_HIDE).
.PP
\fBEnableWindow\fP function enables or disables mouse and keyboard input to the specified window or control. When input is disabled, the window does not receive input such as mouse clicks and key presses. When input is enabled, the window receives all input.
.PP
\fBIsWindowEnabled\fP function determines whether the specified window is enabled for mouse and keyboard input.
.PP
\fBGetClientRect\fP function retrieves the coordinates of a window's client area. The client coordinates specify the upper-left and lower-right corners of the client area. Because client coordinates are relative to the upper-left corner of a window's client area, the coordinates of the upper-left corner are (0,0).
.PP
\fBGetWindowBkColor\fP function returns window current background color.
.PP
\fBGetWindowCursor\fP function gets current cursor of window or control aasociate with parameter \fBhWnd\fP.
.PP
\fBSetWindowCursor\fP function sets current cursor of window or control with parameter \fBhNewCursor\fP.
.PP
\fBGetWindowStyle\fP function gets style set of window or control aasociate with parameter \fBhWnd\fP.
.PP
\fBGetWindowExStyle\fP function gets expand style set of window or control aasociate with parameter \fBhWnd\fP..
.PP
\fBGetWindowAdditionalData\fP function returns additional data of window or control aasociate with parameter \fBhWnd\fP.
.PP
\fBSetWindowAdditionalData\fP function sets additional data of window or control and return old data.
.PP
\fBGetWindowAdditionalData2\fP function is same with \fBGetWindowAdditionalData\fP.
.PP
\fBSetWindowAdditionalData2\fP function is same with\fBSetWindowAdditionalData\fP.
.PP
\fBGetWindowClassAdditionalData\fP function gets additional data of control class.
.PP
\fBSetWindowClassAdditionalData\fP function sets additional data of control class and return old one.
.PP
\fBGetWindowCaption\fP function returns the text of the specified window's title bar.
.PP
\fBSetWindowCaption\fP function changes the text of the specified window's title bar with parameter \fBspCaption\fP.
.PP
\fBInvalidateRect\fP function adds a rectangle to the specified window's update region. The update region represents the portion of the window's client area that must be redrawn, and remain background if parameter bReaseBkgnd is set.
.PP
\fBBeginPaint\fP function prepares the specified window by parameter \fBhWnd\fP for painting.
.PP
\fBEndPaint\fP function marks the end of painting in the specified window. This function is required for each call to the BeginPaint function, but only after painting is complete.
.PP
\fBClientWidthToWindowWidth\fP function returns window width computed with client area width, window border and scroll width.
.PP
\fBClientHeightToWindowHeight\fP function returns window width computed with client area width, window border,window caption,window menu and scroll width.
.PP
\fBClientToScreen\fP function converts the client coordinates of a specified point to screen coordinates.
.PP
\fBScreenToClient\fP function converts the screen coordinates of a specified point on the screen to client coordinates.
.PP
\fBWindowToScreen\fP function converts the window coordinates of a specified point to screen coordinates.
.PP
\fBScreenToWindow\fP function converts the screen coordinates of a specified point on the screen to window coordinates.
.PP
\fBIsMainWindow\fP function tests if window associate with parameter \fBhWnd\fP is main window, return true if does.
.PP
\fBIsControl\fP function tests if window associate with parameter \fBhWnd\fP is control, return true if does.
.PP
\fBIsWindow\fP function determines whether the specified window handle identifies an existing window.
.PP
\fBGetParent\fP function retrieves a handle to the specified child window's parent window.
.PP
\fBIsWindowVisible\fP function retrieves the visibility state of the specified window.
.PP
\fBGetWindowRect\fP function retrieves the dimensions of the bounding rectangle of the specified window. The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen.
.PP
\fBGetHosting\fP function gets current window's hosting windows, a window share message queue with its hosting window.
.PP
\fBGetFirstHosted\fP function gets current window's first hosted window, current window is hosting window of return window.
.PP
\fBGetNextHosted\fP function gets next hosted window of parameter \fBhHosted\fP, window indicated by \fBhHosted\fP is one hosted window of list.
.PP
\fBGetWindowTextLength\fP function retrieves the length, in characters, of the specified window's text. If the specified window is a control, the function retrieves the length of the text within the control.
.PP
\fBGetWindowText\fP function copies the text of the specified window's into a buffer. If the specified window is a control, the text of the control is copied.
.PP
\fBSetWindowText\fP function changes the text of the specified window's text. If the specified window is a control, the text of the control is changed with parameter \fBsPstring\fP.
.PP
\fBSetFocus\fP function sets the keyboard focus to the specified window. The window must be associated with the calling thread's message queue.
.PP
\fBGetFocus\fP function retrieves the handle to the window that has the keyboard focus, if the window is associated with the calling thread's message queue.
.PP
\fBGetFocusChild\fP function retrieves the handle to the window's active child that has the keyboard focus, if the window is associated with the calling thread's message queue.
.PP
\fBSetActiveWindow\fP function activates a window. The window must be associated with the calling thread's message queue.
.PP
\fBGetActiveWindow\fP function retrieves the window handle to the active window associated with the calling thread's message queue.
.PP
\fBSetCapture\fP function sets the mouse capture to the specified window belonging to the current thread. Once a window has captured the mouse, all mouse input is directed to that window, regardless of whether the cursor is within the borders of that window. Only one window at a time can capture the mouse.
If the mouse cursor is over a window created by another thread, the system will
direct mouse input to the specified window only if a mouse button is down.
.PP
\fBGetCapture\fP function retrieves the handle of the window (if any) that has captured the mouse. Only one window at a time can capture the mouse; this window receives mouse input whether or not the cursor is within its borders.
.PP
\fBReleaseCapture\fP function releases the mouse capture from a window in the current thread and restores normal mouse input processing. A window that has captured the mouse receives all mouse input, regardless of the position of the cursor, except when a mouse button is clicked while the cursor hot spot is in the window of another thread.
.PP
\fBMoveWindow\fP function changes the position and dimensions of the specified window. For a top-level window, the position and dimensions are relative to the upper-left corner of the screen. For a child window, they are relative to the upper-left corner of the parent window's client area.
.PP
\fBScrollWindow\fP function scrolls the content of the specified window's client area. The ScrollWindow function exists.
.PP
\fBEnableScrollBar\fP function enables or disables one or both scroll bar arrows.
.PP
\fBGetScrollPos\fP function retrieves the current position of the scroll box (thumb) in the specified scroll bar. The current position is a relative value that depends on the current scrolling range.
.PP
\fBGetScrollRange\fP function sets the position of the scroll box (thumb) in the specified scroll bar and, if requested, redraws the scroll bar to reflect the new position of the scroll box.
.PP
\fBSetScrollPos\fP function sets the position of the scroll box (thumb) in the specified scroll bar and, if requested, redraws the scroll bar to reflect the new position of the scroll box.
.PP
\fBSetScrollRange\fP function sets the minimum and maximum position values for the specified scroll bar.
.PP
\fBShowScrollBar\fP function shows or hides the specified scroll bar.
.PP
\fBSetScrollInfo\fP The SetScrollInfo function sets the parameters of a scroll bar, including the minimum and maximum scrolling positions, the page size, and the position of the scroll box (thumb). The function also redraws the scroll bar, if requested.
.PP
\fBGetScrollInfo\fP The GetScrollInfo function retrieves the parameters of a scroll bar, including the minimum and maximum scrolling positions, the page size, and the position of the scroll box (thumb).
.PP
\fBGetMainWindowHandle\fP function retrieves the handle of the control's main window if hWnd point to a control,otherwise it just return hWnd.
.PP
\fBCreateThreadForMainWindow\fP function creates a thread belong to the calling
process's main window.
.PP
\fBGetMainWinThread\fP function retrieves the main thread of the main window.
.PP
\fBMainWindowThreadCleanup\fP function clean up all the threads belong to the main window.
.PP
\fBWaitMainWindowClose\fP function waits untill the window's main thread exits.
.PP
\fBLoadSystemBitmap\fP function load in bitmaps provided by the system.Parameter 2 specify the name of the bitmap,and the loaded in bitmap is returned as a pointer in parameter 1.
.PP
\fBLoadSystemIcon\fP function load in icons provided by the system. Parameter 2 specify which icon to load in,and the loaded in icon is returned as a pointer in parameter 1.
.SH "RETURN VALUE"
.PP
.SH "NOTE"
.PP
.SH "SEE ALSO"
.SH "AUTHOR"
.PP
This manual page was edited by Kevin <kevin@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

56
doc/man3/miniguiMapTransf.3
View File

@@ -1,56 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "MapTransf" "3" "August 2000" "MiniGUI"
.SH "NAME"
MapTransf \- coordinates transform
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.br
.PP
.BI "void GUIAPI DPtoLP" "(HDC hdc, POINT* pPt);"
.br
.BI "void GUIAPI LPtoDP" "(HDC hdc, POINT* pPt);"
.SH "DESCRIPTION"
.PP
\fBDPtoLP\fP function converts device coordinates into logical coordinates. The conversion depends on the mapping mode of the display context, the settings of the origins and extents for the window and viewport. The x-coordinate and y-coordinate contained in struct \fBpPt\fP will be transformed.
.PP
\fBLPtoDP\fP function converts logical coordinates into device coordinates. The conversion depends on the mapping mode of the display context, the settings of the origins and extents for the window and viewport. The x-coordinate and y-coordinate contained in struct \fBpPt\fP will be transformed.
.SH "NOTE"
.PP
.SH "SEE ALSO"
.BR SetMapMode (3),
.BR SetWindowOrg (3),
.BR SetWindowExt (3),
.BR SetViewportOrg (3),
.BR SetViewportExt (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

115
doc/man3/miniguiMapping.3
View File

@@ -1,115 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "Mapping" "3" "August 2000" "MiniGUI"
.SH "NAME"
Mapping \- coordinates mapping functions.
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.br
.PP
.BI "int GUIAPI GetMapMode" "(HDC hdc);"
.br
.BI "void GUIAPI GetViewportExt" "(HDC hdc, POINT* pPt);"
.br
.BI "void GUIAPI GetViewportOrg" "(HDC hdc, POINT* pPt);"
.br
.BI "void GUIAPI GetWindowExt" "(HDC hdc, POINT* pPt);"
.br
.BI "void GUIAPI GetWindowOrg" "(HDC hdc, POINT* pPt);"
.PP
.BI "void GUIAPI SetMapMode" "(HDC hdc, int mapmode);"
.br
.BI "void GUIAPI SetViewportExt" "(HDC hdc, POINT* pPt);"
.br
.BI "void GUIAPI SetViewportOrg" "(HDC hdc, POINT* pPt);"
.br
.BI "void GUIAPI SetWindowExt" "(HDC hdc, POINT* pPt);"
.br
.BI "void GUIAPI SetWindowOrg" "(HDC hdc, POINT* pPt);"
.SH "DESCRIPTION"
.PP
\fBGetMapMode\fP function retrives the current mapping mode. So far, MiniGUI support two mapping modes:
.PP
.IP \fBMM_TEXT\fP
Each logical unit is mapped to on device pixel. Positive x is to the right; positive y is down.
.IP \fBMM_ANISOTROPIC\fP
Logical units are mapped to arbitrary units with arbitrarily scaled axes; Use \fBSetWindowExt\fP and \fBSetViewportExt\fP functions to specify the units, orientation, and scaling required.
.PP
\fBGetViewportExt\fP function retrieves the x-extents and y-extents of the current viewport for the specified display context \fBhdc\fP. the x- and y-extents, in device units, are placed in \fBpPt\fP struct.
.PP
\fBGetViewportOrg\fP function retrieves the x-coordinates and y-coordinates of the viewport orgin for the specified display context. The \fBpPt\fP struct will receive the viewport origin.
.PP
\fBGetWindowExt\fP function retrives the x-extents and y-extents of the window for the specified display context. The x- and y-extents in page space units (as known as logical units) are placed int \fBpPt\fP struct.
.PP
\fBGetWindowOrg\fP function retrives the x-coordinates and y-coordinates of the window origin for the specified device context. The \fBpPt\fP struct will receive the window origin.
.PP
\fBSetMapMode\fP function sets the mapping mode of the specified display context. The mapping mode defines the unit of measure used to transform page-space units into device-space units, and also defines the orientation of the device's x and y axes. So far, MiniGUI support only two mapping mode: \fBMM_TEXT\fP and \fBMM_ANISOTROPIC\fP.
.PP
\fBSetViewportExt\fP function sets the horizontal and vertical extents of the viewport for a display context by using the specified values in struct \fBpPt\fP.
.PP
\fBSetViewportOrg\fP function sets the viewport origin of a display context by using the specified coordinates in struct \fBpPt\fP.
.PP
\fBSetWindowExt\fP function sets the horizontal and vertical extents of the window for a display context by using the specified values in struct \fBpPt\fP.
.PP
\fBSetWindowOrg\fP function sets the window origin of the display context by using the specified coordinates in struct \fBpPt\fP.
.SH "NOTE"
.PP
The following formula shows the math involved in converting a point from page space to device space.
.PP
Dx = ((Lx - WOx) * VEx / WEx) + VOx
.PP
The following variables are involved:
.PP
.I Dx
x value in device units
.br
.I Lx
x value in logical units (also known as page space units)
.br
.I WOx
window x origin
.br
.I VOx
viewport x origin
.br
.I WEx
window x-extent
.br
.I VEx
viewport x-extent
.PP
The same equation with y replacing x transforms the y component of a point.
.PP
The formula first offsets the point from its coordinate origin. This value, no longer biased by the origin, is then scaled into the destination coordinate system by the ratio of the extents. Finally, the scaled value is offset by the destination origin to its final mapping.
.SH "SEE ALSO"
.BR LPtoDP (3),
.BR DPtoLP (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

152
doc/man3/miniguiMenu.3
View File

@@ -1,152 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "MenuHandler" "3" "August 2000" "MiniGUI"
.SH "NAME"
MenuHandler \- Menu Support Functioins.
.SH "SYNOPSIS"
.B #include <minigui/window.h>
.br
.PP
.BI "HMENU GUIAPI LoadMenuFromFile" "(const char* filename, int id);"
.br
.BI "HMENU GUIAPI CreateMenu" "(void);"
.br
.BI "HMENU GUIAPI CreatePopupMenu" "( PMENUITEMINFO pmii);"
.br
.BI "HMENU GUIAPI CreateSystemMenu" "(HWND hwnd, DWORD dwStyle);"
.br
.BI "int GUIAPI InsertMenuItem" "(HMENU hmnu, int item,BOOL flag, PMENUITEMINFO pmii);"
.br
.BI "int GUIAPI RemoveMenu" "(HMENU hmnu, int item, UINT flags);"
.br
.BI "int GUIAPI DeleteMenu" "(HMENU hmnu, int item, UINT flags);"
.br
.BI "int GUIAPI DestroyMenu" "(HMENU hmnu);"
.br
.BI "int GUIAPI IsMenu" "(HMENU hmnu);"
.br
.BI "HMENU GUIAPI SetMenu" "(HWND hwnd, HMENU hmnu);"
.br
.BI "HMENU GUIAPI GetMenu" "(HWND hwnd);"
.br
.BI "void GUIAPI DrawMenuBar" "(HWND hwnd);"
.br
.BI "int GUIAPI TrackMenuBar" "(HWND hwnd, int pos);"
.br
.BI "int GUIAPI TrackPopupMenu" "(HMENU hmnu, UINT uFlags, int x, int y, HWND hwnd);"
.br
.BI "HMENU GUIAPI GetMenuBarItemRect" "(HWND hwnd, int pos, RECT* prc);"
.br
.BI "BOOL GUIAPI HiliteMenuBarItem" "(HWND hwnd, int pos, UINT flag);"
.br
.BI "int GUIAPI GetMenuItemCount" "(HMENU hmnu);"
.br
.BI "int GUIAPI GetMenuItemID" "(HMENU hmnu, int pos);"
.br
.BI "int GUIAPI GetMenuItemInfo" "(HMENU hmnu, int item, BOOL flag, PMENUITEMINFO pmii);"
.br
.BI "int GUIAPI GetMenuItemRect" "(HWND hwnd, HMENU hmnu, int item, PRECT prc);"
.br
.BI "HMENU GUIAPI GetPopupSubMenu" "(HMENU hpppmnu);"
.br
.BI "HMENU GUIAPI GetSubMenu" "(HMENU hmnu, int pos);"
.br
.BI "int GUIAPI GetSystemMenu" "(HWND hwnd, BOOL flag);"
.br
.BI "UINT GUIAPI EnableMenuItem" "(HMENU hmnu, int item, UINT flags);"
.br
.BI "int GUIAPI CheckMenuRadioItem" "(HMENU hmnu, int first, int last, int checkitem, UINT flags);"
.br
.BI "int GUIAPI SetMenuItemBitmaps" "(HMENU hmnu, int item, UINT flags, PBITMAP hBmpUnchecked, PBITMAP hBmpChecked);"
.br
.BI "int GUIAPI SetMenuItemInfo" "(HMENU hmnu, int item, BOOL flag, PMENUITEMINFO pmii);"
.SH "DESCRIPTION"
.PP
\fBLoadMenuFromFile\fP function loads a menu from a external file. The function is not implemented at current time.
.PP
\fBCreateMenu\fP function creates a menu. The menu is initially empty, but it can be filled with menu items by using the InsertMenuItem, AppendMenu, and InsertMenu functions.
.PP
\fBCreatePopupMenu\fP function creates a drop-down menu or submenu. The menu is initially empty. You can insert or append menu items by using the InsertMenuItem function.
.PP
\fBCreateSystemMenu\fP function creates a system menu. It can be used to replace the application's system menu.
.PP
\fBInsertMenuItem\fP function inserts a new menu item at the specified position in a menu.
.PP
\fBRemoveMenu\fP function deletes a menu item or detaches a submenu from the specified menu.
.PP
\fBDeleteMenu\fP function deletes an item from the specified menu.
.PP
\fBDestroyMenu\fP function destroys the specified menu and frees any memory that the menu occupies.
.PP
\fBIsMenu\fP function determines whether a handle is a menu handle.
.PP
\fBSetMenu\fP function assigns a new menu to the specified window.
.PP
\fBGetMenu\fP function retrieves the handle to the menu assigned to the given window.
.PP
\fBDrawMenuBar\fP function redraws the menu bar of the specified window. If the menu bar changes after the system has created the window, this function must be called to draw the changed menu bar.
.PP
\fBTrackMenuBar\fP function displays the specified submenu.
.PP
\fBTrackPopupMenu\fP function displays a shortcut menu at the specified location and tracks the selection of items on the menu. The shortcut menu can appear anywhere on the screen.
.PP
\fBGetMenuBarItemRect\fP function retrieves the rect of the menu bar item specified by the parameter \fBpos\fP.
.PP
\fBHiliteMenuBarItem\fP function draws the specified menubar item with 3D effect.
.PP
\fBGetMenuItemCount\fP function determines the number of items in the specified menu.
.PP
\fBGetMenuItemID\fP function retrieves the menu item identifier of a menu item at specified position in a menu.
.PP
\fBGetMenuItemInfo\fP function retrieves information about a menu item.
.PP
\fBGetMenuItemRect\fP function retrieves the bounding rectangle for the specified menu item.
.PP
\fBGetPopupSubMenu\fP function retrieves the submenu of the specified popup menu.
.PP
\fBGetSubMenu\fP function retrieves the handle to the drop-down menu or submenu activated by the specified menu item.
.PP
\fBGetSystemMenu\fP function allows the application to access the window menu (also known as the system menu or the control menu) for copying and modifying.
.PP
\fBEnableMenuItem\fP function enables, disables, or grays the specified menu item.
.PP
\fBCheckMenuRadioItem\fP function checks a specified menu item and makes it a radio item. At the same time, the function unchecks all other menu items in the associated group and clears the radio-item type flag for those items.
.PP
\fBSetMenuItemBitmaps\fP function associates the specified bitmap with a menu item. Whether the menu item is checked or unchecked, the system displays the appropriate bitmap next to the menu item.
.PP
\fBSetMenuItemInfo\fP function changes information about a menu item.
.SH "RETURN VALUE"
.PP
.SH "NOTE"
.PP
.SH "SEE ALSO"
.SH "AUTHOR"
.PP
This manual page was edited by Song Lixin <zjujoe@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

101
doc/man3/miniguiMessage.3
View File

@@ -1,101 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" Modified 2000/11/30 by Wei Yongming.
.TH "Message" "3" "August 2000" "MiniGUI"
.SH "NAME"
Message \- message function of MiniGUI.
.SH "SYNOPSIS"
.B #include <minigui/window.h>
.br
.PP
.BI "int GUIAPI GetMessage" "(PMSG pMsg, HWND hMainWnd);"
.br
.BI "BOOL GUIAPI HavePendingMessage" "(HWND hMainWnd);"
.br
.BI "int GUIAPI PostMessage" "(HWND hWnd, int iMsg, WPARAM wParam, LPARAM lParam);"
.br
.BI "int GUIAPI SendMessage" "(HWND hWnd, int iMsg, WPARAM wParam, LPARAM lParam);"
.br
.BI "int GUIAPI PostSyncMessage" "(HWND hWnd, int iMsg, WPARAM wParam, LPARAM lParam);"
.br
.BI "int GUIAPI SendAsyncMessage" "(HWND hWnd, int iMsg, WPARAM wParam, LPARAM lParam);"
.br
.BI "int GUIAPI SendNotifyMessage" "(HWND hWnd, int iMsg, WPARAM wParam, LPARAM lParam);"
.br
.BI "int GUIAPI BroadcastMessage" "(int iMsg, WPARAM wParam, LPARAM lParam);"
.br
.BI "int GUIAPI PostQuitMessage" "(HWND hWnd);"
.br
.BI "int GUIAPI TranslateMessage" "(PMSG pMsg);"
.br
.BI "int GUIAPI DispatchMessage" "(PMSG pMsg);"
.br
.BI "int GUIAPI ThrowAwayMessages" "(HWND pMainWnd);"
.br
.BI "int GUIAPI TranslateAccelerator" "(HWND hWnd, HACCEL hAccel, PMSG pMsg);"
.SH "DESCRIPTION"
.PP
\fBGetMessage\fP function gets a message from the message queue of the window \fBhWnd\fP. It will return until there is a message in the message queue.
.PP
\fBHavePendingMessage\fP function checks if there is any message in the message queue. This function returns TRUE when message queue is not empty.
.PP
\fBPostMessage\fP function posts a message into the message queue of the window \fBhWnd\fP and returns immediatly.
.PP
\fBSendMessage\fP function sends a message to the window \fBhWnd\fP.
.PP
\fBPostSyncMessage\fP function posts a synchronous message to the destination window \fBhWnd\fP, and returns until the message is handled by the window procedure. Note that the destination window must belong to other thread.
.PP
\fBSendAsyncMessage\fP function sends a asynchronous message to the destination window \fBhWnd\fP, and calls the window procedure immediately. Note that this function may corrupt your data.
.PP
\fBSendNotifyMessage\fP function sends a notification message to the destination window \fBhWnd\fP. If the window is belong to the same thread, this function acts same as \fBSendMessage\fP, else same as \fBPostMessage\fP.
.PP
\fBBroadcastMessage\fP function broadcasts a message to all main window on the desktop.
.PP
\fBPostQuitMessage\fP function puts a MSG_QUIT message into the message queue.
.PP
\fBTranslateMessage\fP function translates key down and key up message to WM_CHAR message and puts it into message queue.
.PP
\fBDispatchMessage\fP function dispatchs a message to the destination window's callback procedure.
.PP
\fBThrowAwayMessages\fP function removes all messages in the message queue associated with the current window.
.PP
\fBTranslateAccelerator\fP function translates an accelerator key message to WM_COMMAND messge and sends it to window procdure.
.SH "RETURN VALUE"
.PP
.SH "NOTE"
.PP
.SH "SEE ALSO"
.SH "AUTHOR"
.PP
This manual page was edited by Kevin <kevin@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

34
doc/man3/miniguiMessages.3
View File

@@ -1,34 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "Messages" "3" "Nov. 2000" "MiniGUI"
.SH "NAME"
Messages \- Message list of MiniGUI version 1.x.
.PP
This page is under construction.
.SH "AUTHOR"
.PP
This manual page was edited by Wei Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

81
doc/man3/miniguiMisc.3
View File

@@ -1,81 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "Misc" "3" "July 2000" "MiniGUI"
.SH "NAME"
Misc \- the miscellouse functions of MiniGUI
.SH "SYNOPSIS"
.B #include <minigui/minigui.h>
.PP
.BI "void GUIAPI Ping" "(void);"
.br
.BI "void GUIAPI Beep" "(void);"
.br
.BI "void GUIAPI Tone" "(int frequency_hz, int duration_ms);"
.PP
.BI "void* GUIAPI GetOriginalTermIO" "(void);"
.PP
.BI "void GUIAPI Draw3DUpFrame" "(HDC hDC, int l, int t, int r, int b, int fillc);"
.br
.BI "void GUIAPI Draw3DDownFrame" "(HDC hDC, int l, int t, int r, int b, int fillc);"
.br
.BI "void GUIAPI Draw3DUpThickFrame" "(HDC hDC, int l, int t, int r, int b, int fillc);"
.br
.BI "void GUIAPI Draw3DDownThickFrame" "(HDC hDC, int l, int t, int r, int b, int fillc);"
.br
.BI "void GUIAPI Draw3DBorder" "(HDC hDC, int l, int t, int r, int b);"
.PP
.BI "void GUIAPI DisabledTextOut" "(HDC hDC, int x, int y, const char* szText);"
.SH "DESCRIPTION"
.PP
\fBPing\fP print a "\\a" to \fBstdout\fP.
.PP
\fBBeep\fP functions same as \fBPing\fP.
.PP
\fBTone\fP make a tone with \fBfrequency_hz\fP Hertz by using PC speaker. The tone will go on \fBduration_ms\fP milliseconds. Note that this function will not function on X Window. Also note that the function will return immetiately other than waiting within the duration of the tone.
.PP
\fBGetOriginalTermIO\fP returns the original \fBtermio\fP before MiniGUI startup. Before switch to graphics mode on console, MiniGUI will save the original \fBtermio\fP of the console. You can get the \fBtermio\fP with this function.
.PP
\fBDraw3DUpFrame\fP draws a 3D frame looks like up, and fills the frame with \fBfillc\fP color if \fBfillc\fP is greater than or equal to zero.
.PP
\fBDraw3DDownFrame\fP draws a 3D frame looks like down, and fill frame with \fBfillc\fP color if \fBfillc\fP is greater than or equal to zero.
.PP
\fBDraw3DUpThickFrame\fP functions like \fBDraw3DUpFrame\fP, but draws a thin frame other than thick frame.
.PP
\fBDraw3DDownThickFrame\fP functions like \fBDraw3DDownFrame\fP, but draws a thin frame other than thick frame.
.PP
\fBDraw3DBorder\fP draws the border of a 3D-look frame.
.PP
\fBDisabledTextOut\fP outputs a gray text pointer to \fBszText\fP at \fB(x, y)\fP by using \fBTextOut\fP.
.PP
\fBhDC\fP is the handle to current display content.
.PP
\fBl, t, r, b\fP are the left, top, right, bottom of the rectangle respectively.
.SH "SEE ALSO"
.BR TextOut "(3), " iotcl (2)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

83
doc/man3/miniguiPenBrush.3
View File

@@ -1,83 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "PenBrush" "3" "August 2000" "MiniGUI"
.SH "NAME"
PenBrush \- get/set the pen and brush attributes of a DC.
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.br
.PP
.BI "gal_pixel GUIAPI GetPenColor" "(HDC hdc);"
.br
.BI "gal_pixel GUIAPI SetPenColor" "(HDC hdc, gal_pixel color);"
.br
.BI "int GUIAPI GetPenType" "(HDC hdc);"
.br
.BI "int GUIAPI SetPenType" "(HDC hdc, int pentype);"
.PP
.BI "gal_pixel GUIAPI GetBrushColor" "(HDC hdc);"
.br
.BI "gal_pixel GUIAPI SetBrushColor" "(HDC hdc, gal_pixel color);"
.br
.BI "int GUIAPI GetBrushType" "(HDC hdc);"
.br
.BI "int GUIAPI SetBrushType" "(HDC hdc, int brushtype);"
.SH "DESCRIPTION"
.PP
\fBGetPenColor\fP function returns the pen color of the DC.
.PP
\fBSetPenColor\fP function sets the pen color of the DC.
.PP
\fBGetPenType\fP function gets the pen type of the DC. So far, this function has no effect.
.PP
\fBSetPenType\fP function sets the pen type of the DC. So far, this function has no effect.
.PP
\fBGetBrushColor\fP function returns the brush color of the DC.
.PP
\fBSetBrushColor\fP function set the brush color of the DC.
.PP
\fBGetBrushType\fP function returns the brush type of the DC. So far, this function has no effect.
.PP
\fBSetBrushType\fP function sets the brush type of the DC. So far, this function has no effect.
.SH "RETURN VALUE"
.PP
The \fBGet...\fP functions return the value wanted. The \fBSet...\fP functions return the old value.
.SH "NOTE"
.PP
So far, there is no any advanced 2D raster operation in MiniGUI. So some function above have not any effect.
.SH "SEE ALSO"
.BR LineTo (3),
.BR Rectangle (3),
.BR FillBox (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

128
doc/man3/miniguiRect.3
View File

@@ -1,128 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "Rect" "3" "August 2000" "MiniGUI"
.SH "NAME"
Rect \- Rectangle operations in MiniGUI.
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.br
.PP
.BI "void GUIAPI SetRect" "(RECT* prc, int left, int top, int right, int bottom);"
.br
.BI "void GUIAPI SetRectEmpty" "(RECT* prc);"
.br
.BI "void GUIAPI CopyRect" "(RECT* pdrc, const RECT* psrc);"
.br
.BI "BOOL GUIAPI IsRectEmpty" "(const RECT* prc);"
.br
.BI "BOOL GUIAPI EqualRect" "(const RECT* prc1, const RECT* prc2);"
.br
.BI "void GUIAPI NormalizeRect" "(RECT* pRect);"
.br
.BI "BOOL GUIAPI IntersectRect" "(RECT* pdrc, const RECT* psrc1, const RECT* psrc2);"
.br
.BI "BOOL GUIAPI IsCovered" "(const RECT* prc1, const RECT* prc2);"
.br
.BI "BOOL GUIAPI DoesIntersect" "(const RECT* psrc1, const RECT* psrc2);"
.br
.BI "BOOL GUIAPI UnionRect" "(RECT* pdrc, const RECT* psrc1, const RECT* psrc2);"
.br
.BI "void GUIAPI GetBoundRect" "(PRECT pdrc, const RECT* psrc1, const RECT* psrc2);"
.br
.BI "int GUIAPI SubtractRect" "(RECT* rc, const RECT* psrc1, const RECT* psrc2);"
.br
.BI "void GUIAPI OffsetRect" "(RECT* prc, int x, int y);"
.br
.BI "void GUIAPI InflateRect" "(RECT* prc, int cx, int cy);"
.br
.BI "void GUIAPI InflateRectToPt" "(RECT* prc, int x, int y);"
.br
.BI "BOOL GUIAPI PtInRect" "(const RECT* prc, int x, int y);"
.SH "DESCRIPTION"
.PP
\fBSetRect\fP function sets the rectangle with specified values. A rectangle in MiniGUI is a struct defined as:
.PP
.nf
typedef struct tagRECT
{
int left;
int top;
int right;
int bottom;
} RECT;
typedef RECT* PRECT;
typedef RECT* LPRECT;
.fi
.PP
\fBSetRectEmpty\fP function empties the rectangle pointed to by \fBprc\fP. A empty rectangle in MiniGUI is a rectangle whose width and height both are zero. This function will sets all coordinates of the rectangle to zero.
.PP
\fBCopyRect\fP function copies the coordinates of the source rectangle pointed to by \fBpsrc\fP to the destination rectangle pointed to by \fBpdrc\fP.
.PP
\fBIsRectEmpty\fP function determines whether the specified rectangle is empty. A empty rectangle is one that has no area; that is, the coordinates of the right side is equal to the coordinate of the left side, or the coordinates of the bottom side is equal to the coordinate of the top side.
.PP
\fBEqualRect\fP function determines whether the two specified rectangles \fB(prc1 and prc2)\fP are equal by comparing the coordinates of the upper-left and lower-right corners.
.PP
\fBNormalizeRect\fP function normalizes the rectangle pointed to by \fBprc\fP so that both the height and width are positive.
.PP
\fBIntersectRect\fP function calculates the intersection of two source rectangle \fB(psrc1 and psrc2)\fP and places the coordinates of the intersection rectangle into the destination rectangle. If the source rectangls do not intersect, and empty rectangle (in which all coordinates are set to zero) is placed into the destination rectangle.
.PP
\fBIsCovered\fP function determines whether one rectangle \fB(prc1)\fP is cover another rectangle \fB(prc2)\fP.
.PP
\fBDoesIntersect\fP function determines whether two rectangles intersect.
.PP
\fBUnionRect\fP function creates the union \fB(pdrc)\fP of two rectangles \fB(psrc1, psrc2)\fP. The union is the smallest rectangle that contains both source rectangles. This function is different from its Windows version, the source rectangles must be border upon and not stagger.
.PP
\fBGetBoundRect\fP function creates the bound rect \fB(pdrc)\fP of two rectangles \fB(psrc1, prsrc2)\fP. the bound rect is the smallest rectangle that contains both source rectangles.
.PP
\fBSubtractRect\fP function obtains the rectangles when substracting one rectangle from another. \fBrc\fP should be an array of RECT struct, and may contain at most four rectangles. This function returns the number of result rectangles.
.PP
\fBOffsetRect\fP function moves the specified rectangle by the specified offsets. \fBdx\fP and \fBdy\fP specify the amount to move the rectangle left/right or up/down respectively. \fBdx\fP must be a negative value to move the rectangle to the left, and \fBdy\fP must be a negative value to move the rectangle up.
.PP
\fBInflateRect\fP function increases or decreases the width and height of the specified rectangle. This function adds \fBdx\fP units to the left and right ends of the rectangle and \fBdy\fP units to the top and bottom. the \fBdx\fP and \fBdy\fP are signed values; positive values increases the width and height, and negative values decreases them.
.PP
\fBInflateRectToPt\fP function inflates the rectangle to contain the specified point \fB(x, y)\fP.
.PP
\fBPtInRect\fP function determines whether the specified point lies within the specified rectangle. A point is within a rectangle if it lies on the left or top side or is within all four sides. A point on the right or bottom side is considered outside the rectangle.
.SH "NOTE"
.PP
Note that some rectangle functions in MiniGUI are not equivalents of their Windows version. The following macros can help you determine the width and height of a rectangle object:
.nf
#define RECTWP(prc) (prc->right - prc->left)
#define RECTHP(prc) (prc->bottom - prc->top)
#define RECTW(rc) (rc.right - rc.left)
#define RECTH(rc) (rc.bottom - rc.top)
.fi
.SH "SEE ALSO"
.PP
.BR GetClipRgnBoundRect (3),
.BR SubtractClipRect (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming (ymwei@minigui.org)
If you have any problems, comments or found some bugs, please send messages to me.

87
doc/man3/miniguiRegion.3
View File

@@ -1,87 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "ClipRgn" "3" "August 2000" "MiniGUI"
.SH "NAME"
ClipRgn \- operations of region.
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.PP
.BI "void GUIAPI InitClipRgn" "(PCLIPRGN pRgn, PFREECLIPRECTLIST pFreeList);"
.br
.BI "BOOL GUIAPI ClipRgnCopy" "(PCLIPRGN pDstRgn, const CLIPRGN* pSrcRgn);"
.br
.BI "BOOL GUIAPI ClipRgnIntersect" "(PCLIPRGN pRstRgn, const CLIPRGN* pRgn1, const CLIPRGN* pRgn2);"
.br
.BI "void GUIAPI GetClipRgnBoundRect" "(PCLIPRGN pRgn, PRECT pRect);"
.br
.BI "BOOL GUIAPI SetClipRgn" "(PCLIPRGN pRgn, const RECT* pRect);"
.br
.BI "BOOL GUIAPI IsEmptyClipRgn" "(const CLIPRGN* pRgn);"
.br
.BI "void GUIAPI EmptyClipRgn" "(PCLIPRGN pRgn);"
.br
.BI "BOOL GUIAPI AddClipRect" "(PCLIPRGN pRgn, const RECT* pRect);"
.br
.BI "BOOL GUIAPI IntersectClipRect" "(PCLIPRGN pRgn, const RECT* pRect);"
.br
.BI "BOOL GUIAPI SubtractClipRect" "(PCLIPRGN pRgn, const RECT* pRect);"
.SH "DESCRIPTION"
.PP
Region in MiniGUI is a set of no-intersected rects. We call region as clipping region in functions due to the reason of history.
.PP
\fBInitClipRgn\fP function initializes the region specified by \fBpRgn\fP, and tells the region to use \fBpFreeList\fP to allocate rects.
.PP
\fBClipRgnCopy\fP function copies the region pointed to by \fBpSrcRgn\fP to the region pointed to by \fBpDstRgn\fP. This function will empty the region \fBpDstRgn\fP first.
.PP
\fBClipRgnIntersect\fP function gets the intersection of two regions pointed to by \fBpRgn1\fP and \fBpRgn2\fP respectively and puts the result to the region pointed to by \fBpRstRgn\fP.
.PP
\fBGetClipRgnBoundRect\fP function gets the bounding rect of the region pointed to by \fBpRgn\fP, and returns the rect in the rect pointed to by \fBpRect\fP.
.PP
\fBSetClipRgn\fP function sets the region \fBpRgn\fP to contain only a rect pointed to by \fBpRect\fP. This function will empty the region first.
.PP
\fBIsEmptyClipRgn\fP function determines whether the region pointed to by \fBpRgn\fP is an empty region. TRUE for empty one, else for not empty region.
.PP
\fBEmptyClipRgn\fP function empties the region pointed to by \fBpRgn\fP.
.PP
\fBAddClipRect\fP function appends a rect to the region pointed to by \fBpRgn\fP.
.PP
\fBIntersectClipRect\fP function intersects the region pointed to by \fBpRgn\fP with a rect pointed to by \fBpRect\fP.
.PP
\fBSubtractClipRect\fP function substracts a rect pointed to by \fBprect\fP from the region \fBpRgn\fP.
.SH "RETURN VALUE"
.PP
All above functions return FALSE when an error occurred, else return TRUE to indicate success.
.SH "NOTE"
.PP
.SH "SEE ALSO"
.BR InitFreeClipRectList (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

65
doc/man3/miniguiScreen.3
View File

@@ -1,65 +0,0 @@
.\" This manpage is Copyright (C) 2000 Wei Yongming
.\" 2000 BluePoint Software
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since MiniGUI is constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.TH "Screen" "3" "August 2000" "MiniGUI"
.SH "NAME"
Screen \- Screen image operations.
.SH "SYNOPSIS"
.B #include <minigui/gdi.h>
.br
.PP
.BI "void GUIAPI SaveScreenBox" "(int x, int y, int w, int h, void* vbuf);"
.br
.BI "void* GUIAPI SaveCoveredScreenBox" "(int x, int y, int w, int h);"
.br
.BI "BOOL GUIAPI SaveMainWindowContent" "(HWND hWnd, const char* filename);"
.br
.BI "void GUIAPI PutSavedBoxOnScreen" "(int x, int y, int w, int h, void* vbuf);"
.br
.BI "void GUIAPI PutSavedBoxOnDC" "(HDC hdc, int x, int y, int w, int h, void* vbuf);"
.br
.BI "void GUIAPI ScreenCopy" "(int sx, int sy, HDC hdc, int dx, int dy);"
.SH "DESCRIPTION"
.PP
\fBSaveScreenBox\fP function saves screen image in the memory pointed to by \fBvbuf\fP. The image box begins at \fB(x, y)\fP, and is \fBw\fP wide and \fBh\fP high. You must sure that \fBvbuf\fP is big enough to store the image.
.PP
\fBSaveCoveredScreenBox\fP function is similar with \fBSaveScreenBox\fP, but this function will allocate memory for you. When allocation of memory failure, the function will return \fBNULL\fP to indicate this error case.
.PP
\fBSaveMainWindowContent\fP function saves a main window image content into a file named \fBfilename\fP in Windows BMP file format. The handle \fBhWnd\fP specifies the main window. If there are some errors occurred, this function will return \fBFALSE\fP, else return \fBTRURE\fP.
.PP
\fBPutSavedBoxOnScreen\fP function puts a pre-saved image in the memory pointed to by \fBvbuf\fP on the screen. This function will scale the image when necessary.
.PP
\fBPutSavedBoxOnDC\fP function puts a pre-saved image in the memory pointed to by \fBvbuf\fP on the DC \fBhdc\fP.
.PP
\fBScreenCopy\fP function copies screen ranged in the DC \fBhdc\fP from \fB(sx, xy)\fP to \fB(dx, dy)\fP. Note that the coordinates are in device coordinate system.
.SH "SEE ALSO"
.BR FillBoxWithBitmap (3),
.BR BitBlt (3)
.SH "AUTHOR"
.PP
This manual page was edited by WEI Yongming <ymwei@minigui.org>.
If you have any problems, comments or found some bugs, please send messages to me.

Some files were not shown because too many files have changed in this diff Show More