mgeff-effector-source.h File Reference

Effector source headfile. More...

#include <minigui/common.h>
#include <minigui/minigui.h>
#include <minigui/gdi.h>
#include <minigui/window.h>

Go to the source code of this file.

Typedefs
typedef void(*	MGEFF_DELETEHDC_CB) (HDC hdc)
	delete source dc More...

Functions
	MGEFF_DECLARE_HANDLE (MGEFF_SOURCE)
MGEFF_EXPORT MGEFF_SOURCE	mGEffCreateSource (HDC hdc)
	Creates a source ready to be used by a effector. More...
MGEFF_EXPORT MGEFF_SOURCE	mGEffCreateSourceEx (HDC hdc, MGEFF_DELETEHDC_CB cb)
	Creates a source ready to be used by a effector and privies the source with a callback to delete DC when the source is deleted. More...
MGEFF_EXPORT HDC	mGEffGetSourceDC (MGEFF_SOURCE handle)
	Get HDC from the source handle. More...

Detailed Description

Effector source headfile.

============================================================================

Author

WanZheng

Version

1.0

Date

02/03/2010 05:22:39 PM

   This file is part of mGEff, a component for MiniGUI.

   Copyright (C) 2008~2018, Beijing FMSoft Technologies Co., Ltd.

   This program is free software: 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 3 of the License, or
   (at your option) any later version.

   This program 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.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Or,

   As this program is a library, any link to this program must follow
   GNU General Public License version 3 (GPLv3). If you cannot accept
   GPLv3, you need to be licensed from FMSoft.

   If you have got a commercial license of this program, please use it
   under the terms and conditions of the commercial license.

   For more information about the commercial license, please refer to
   <http://www.minigui.com/en/about/licensing-policy/>.

Typedef Documentation

void(* MGEFF_DELETEHDC_CB)(HDC hdc)

delete source dc

Parameters

hdc	source hdc

Function Documentation

MGEFF_DECLARE_HANDLE

(

MGEFF_SOURCE

)

The handle to the effector source.

MGEFF_SOURCE mGEffCreateSource

(

HDC

hdc

)

Creates a source ready to be used by a effector.

This function creates a effector source whose underlying DC is the DC specified by hdc.

Parameters

hdc	The handle of the DC.

Returns

the handle fo the newly created effector source.

See also

mGEffCreateSourceEx.

MGEFF_SOURCE mGEffCreateSourceEx	(	HDC	hdc,
		MGEFF_DELETEHDC_CB	cb
	)

Creates a source ready to be used by a effector and privies the source with a callback to delete DC when the source is deleted.

This function creates a effector source whose underlying DC is the DC specified by hdc and the dc will be deleted using the callback specified by cb when the source is deleted.

Parameters

hdc	The handle of the DC.
cb	The callback to delte the underlying dc when source is deleted.

Returns

the handle fo the newly created effector source.

See also

mGEffCreateSource.

HDC mGEffGetSourceDC

(

MGEFF_SOURCE

handle

)

Get HDC from the source handle.

This function return DC from source specified by handle.

Parameters

handle

The handle of the source.

Returns

dc of source.

See also

.