[occt.git] / src / WNT / WNT_Window.cdl

-- Created on: 1996-01-26
-- Created by: PLOTNIKOV Eugeny
-- Copyright (c) 1996-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and / or modify it
-- under the terms of the GNU Lesser General Public version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.

class Window from WNT inherits Window from Aspect

	---Purpose: This class defines Windows NT window

 uses

    Handle             from Aspect,
    TypeOfResize       from Aspect,
    NameOfColor        from Quantity,
    Color              from Quantity,
    Ratio              from Quantity,
    WClass             from WNT,
    Uint               from WNT,
    Dword              from WNT,
    WindowData         from WNT

 raises

    WindowDefinitionError from Aspect,
    WindowError           from Aspect

 is
 
    Create (theTitle        : CString       from Standard;
            theClass        : WClass        from WNT;
            theStyle        : Dword         from WNT;
            thePxLeft       : Integer       from Standard;
            thePxTop        : Integer       from Standard;
            thePxWidth      : Integer       from Standard;
            thePxHeight     : Integer       from Standard;
            theBackColor    : NameOfColor   from Quantity = Quantity_NOC_MATRAGRAY;
            theParent       : Handle        from Aspect = 0;
            theMenu         : Handle        from Aspect = 0;
            theClientStruct : Address       from Standard = 0)
     returns mutable Window from WNT
     ---Level:   Public
     ---Purpose: Creates a Window defined by his position and size
     --	    in pixles from the Parent Window.
     --  Trigger: Raises WindowDefinitionError if the Position out of the
     --          Screen Space or the window creation failed.
     raises WindowDefinitionError from Aspect;

    Create (
     aHandle    : Handle        from Aspect;
     aBackColor : NameOfColor   from Quantity = Quantity_NOC_MATRAGRAY
    )
     returns mutable Window from WNT;
     	---Level:   Public
     	---Purpose: Creates a Window based on the existing window handle.
        --          This handle equals ( aPart1 << 16 ) + aPart2.

    Create (
     aPart1     : Integer       from Standard;
     aPart2     : Integer       from Standard;
     aBackColor : NameOfColor   from Quantity = Quantity_NOC_MATRAGRAY
    )
     returns mutable Window from WNT;
     	---Level:   Public
     	---Purpose: Creates a Window based on the existing window <aHandle>.

    Destroy ( me : mutable )
     is virtual;
	---Level:   Public
	---Purpose: Destroies the Window and all resourses attached to it.
	---C++:     alias ~


    ---------------------------------------------------
	-- Category: Methods to modify the class definition
	---------------------------------------------------

    SetCursor ( me; aCursor : Handle from Aspect )
     is static;
     	---Level:   Public
     	---Purpose: Sets cursor <aCursor> for ENTIRE WINDOW CLASS to which
     	--          the Window belongs.

    Map ( me )
     is virtual;
	---Level:    Public
	---Purpose:  Opens the window <me>.

    Map ( me; aMapMode : Integer from Standard )
     is static;
     	---Level:   Public
     	---Purpose: Opens a window <me> according to <aMapMode>.
     	--          This method is specific to Windows NT.
     	--          <aMapMode> can be one of SW_xxx constants defined
     	--          in <windows.h>. See documentation.

    Unmap ( me )
     is virtual;
	---Level:   Public
	---Purpose: Closes the window <me>.

    DoResize ( me )
     returns TypeOfResize from Aspect
	---Level:   Public
	---Purpose: Applies the resizing to the window <me>.
     raises WindowError from Aspect is virtual;

    DoMapping ( me ) returns Boolean from Standard
	    raises WindowError from Aspect is virtual;
   	---Level: Advanced
    	---Purpose: Apply the mapping change to the window <me>
    	-- and returns TRUE if the window is mapped at screen.
    	---Category: Methods to modify the class definition

    SetPos ( me : mutable; X, Y, X1, Y1 : Integer from Standard )
     is static;
        ---Level:   Internal
        ---Purpose: Changes variables due to window position.

    SetFlags ( me : mutable; aFlags : Integer from Standard )
     is static;
     	---Level:   Public
     	---Purpose: Sets user defined flags in the extra window data area.
	--          Supported flags WDF_* are listed in InterfaceGraphic_WNT.hxx
	--          In particular, the window backround can be turned off using this method.

    ResetFlags ( me : mutable; aFlags : Integer from Standard )
     is static;
     	---Level:   Public
    	---Purpose: Reset specified flags in the extra window data area.
	--          Supported flags WDF_* are listed in InterfaceGraphic_WNT.hxx
	--          In particular, the window backround can be turned on using this method.


 	----------------------------
	-- Category: Inquire methods
	----------------------------

    IsMapped ( me )
     returns Boolean from Standard  is virtual;
	---Level:   Public
	---Purpose: Returns True if the window <me> is opened
	--	        and False if the window is closed.

    Ratio ( me )
     returns Ratio from Quantity  is virtual;
	---Level:   Public
	---Purpose: Returns The Window RATIO equal to the physical
	--	    WIDTH/HEIGHT dimensions.

    Position (
     me;
     X1 : out Integer from Standard;
     Y1 : out Integer from Standard;
     X2 : out Integer from Standard;
     Y2 : out Integer from Standard
    )
     is virtual;
	---Level:   Public
	---Purpose: Returns The Window POSITION in PIXEL

    Size (
     me;
     Width  : out Integer from Standard;
     Height : out Integer from Standard
    )
     is virtual;
	---Level:   Public
	---Purpose: Returns The Window SIZE in PIXEL

    HWindow ( me )
     returns Handle from Aspect is static;
	---Level:   Public
	---Purpose: Returns the Windows NT handle of the created window <me>.
        ---C++:     inline

    HParentWindow ( me )
     returns Handle from Aspect is static;
	---Level:   Public
	---Purpose: Returns the Windows NT handle parent of the created window <me>.
        ---C++:     inline

    doCreate (
     me         : mutable;
     aHandle    : Handle        from Aspect;
     aBackColor : NameOfColor   from Quantity = Quantity_NOC_MATRAGRAY
    ) is static private;
     	---Level:   Private
     	---Purpose: private method

 fields

    aXLeft          : Integer      from Standard is protected; -- Window coordinates
    aYTop           : Integer      from Standard is protected;
    aXRight         : Integer      from Standard is protected;
    aYBottom        : Integer      from Standard is protected;
    myWClass        : WClass       from WNT      is protected; -- Window class
    myHWindow       : Handle       from Aspect   is protected; -- Window handle
    myHParentWindow : Handle       from Aspect   is protected; -- Parent window handle
    myExtraData     : WindowData   from WNT      is protected; -- additional data
    myUsrData       : Address      from Standard is protected;

end Window;
Commit	Line	Data
b311480e	1	-- Created on: 1996-01-26
	2	-- Created by: PLOTNIKOV Eugeny
	3	-- Copyright (c) 1996-1999 Matra Datavision
973c2be1	4	-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e	5	--
973c2be1	6	-- This file is part of Open CASCADE Technology software library.
b311480e	7	--
973c2be1	8	-- This library is free software; you can redistribute it and / or modify it
	9	-- under the terms of the GNU Lesser General Public version 2.1 as published
	10	-- by the Free Software Foundation, with special exception defined in the file
	11	-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	12	-- distribution for complete text of the license and disclaimer of any warranty.
b311480e	13	--
973c2be1	14	-- Alternatively, this file may be used under the terms of Open CASCADE
973c2be1	15	-- commercial license or contractual agreement.
b311480e	16
7fd59977	17	class Window from WNT inherits Window from Aspect
	18
	19	---Purpose: This class defines Windows NT window
7fd59977	20
	21	uses
	22
	23	Handle from Aspect,
7fd59977	24	TypeOfResize from Aspect,
7fd59977	25	NameOfColor from Quantity,
7fd59977	26	Color from Quantity,
7fd59977	27	Ratio from Quantity,
7fd59977	28	WClass from WNT,
7fd59977	29	Uint from WNT,
7fd59977	30	Dword from WNT,
dc3fe572	31	WindowData from WNT
7fd59977	32
	33	raises
	34
	35	WindowDefinitionError from Aspect,
	36	WindowError from Aspect
	37
	38	is
dc3fe572	39
dc3fe572	40	Create (theTitle : CString from Standard;
7fd59977	41	theClass : WClass from WNT;
	42	theStyle : Dword from WNT;
	43	thePxLeft : Integer from Standard;
	44	thePxTop : Integer from Standard;
	45	thePxWidth : Integer from Standard;
	46	thePxHeight : Integer from Standard;
	47	theBackColor : NameOfColor from Quantity = Quantity_NOC_MATRAGRAY;
	48	theParent : Handle from Aspect = 0;
	49	theMenu : Handle from Aspect = 0;
	50	theClientStruct : Address from Standard = 0)
	51	returns mutable Window from WNT
	52	---Level: Public
	53	---Purpose: Creates a Window defined by his position and size
	54	-- in pixles from the Parent Window.
	55	-- Trigger: Raises WindowDefinitionError if the Position out of the
	56	-- Screen Space or the window creation failed.
	57	raises WindowDefinitionError from Aspect;
	58
	59	Create (
7fd59977	60	aHandle : Handle from Aspect;
	61	aBackColor : NameOfColor from Quantity = Quantity_NOC_MATRAGRAY
	62	)
	63	returns mutable Window from WNT;
	64	---Level: Public
	65	---Purpose: Creates a Window based on the existing window handle.
	66	-- This handle equals ( aPart1 << 16 ) + aPart2.
	67
	68	Create (
7fd59977	69	aPart1 : Integer from Standard;
	70	aPart2 : Integer from Standard;
	71	aBackColor : NameOfColor from Quantity = Quantity_NOC_MATRAGRAY
	72	)
	73	returns mutable Window from WNT;
	74	---Level: Public
	75	---Purpose: Creates a Window based on the existing window <aHandle>.
	76
	77	Destroy ( me : mutable )
	78	is virtual;
	79	---Level: Public
	80	---Purpose: Destroies the Window and all resourses attached to it.
	81	---C++: alias ~
	82
	83
	84	---------------------------------------------------
	85	-- Category: Methods to modify the class definition
	86	---------------------------------------------------
	87
7fd59977	88	SetCursor ( me; aCursor : Handle from Aspect )
	89	is static;
	90	---Level: Public
	91	---Purpose: Sets cursor <aCursor> for ENTIRE WINDOW CLASS to which
	92	-- the Window belongs.
	93
7fd59977	94	Map ( me )
	95	is virtual;
	96	---Level: Public
	97	---Purpose: Opens the window <me>.
	98
	99	Map ( me; aMapMode : Integer from Standard )
	100	is static;
	101	---Level: Public
	102	---Purpose: Opens a window <me> according to <aMapMode>.
	103	-- This method is specific to Windows NT.
	104	-- <aMapMode> can be one of SW_xxx constants defined
	105	-- in <windows.h>. See documentation.
	106
	107	Unmap ( me )
	108	is virtual;
	109	---Level: Public
	110	---Purpose: Closes the window <me>.
	111
	112	DoResize ( me )
	113	returns TypeOfResize from Aspect
	114	---Level: Public
	115	---Purpose: Applies the resizing to the window <me>.
	116	raises WindowError from Aspect is virtual;
	117
	118	DoMapping ( me ) returns Boolean from Standard
	119	raises WindowError from Aspect is virtual;
	120	---Level: Advanced
	121	---Purpose: Apply the mapping change to the window <me>
	122	-- and returns TRUE if the window is mapped at screen.
	123	---Category: Methods to modify the class definition
	124
7fd59977	125	SetPos ( me : mutable; X, Y, X1, Y1 : Integer from Standard )
	126	is static;
	127	---Level: Internal
	128	---Purpose: Changes variables due to window position.
	129
	130	SetFlags ( me : mutable; aFlags : Integer from Standard )
	131	is static;
	132	---Level: Public
	133	---Purpose: Sets user defined flags in the extra window data area.
	134	-- Supported flags WDF_* are listed in InterfaceGraphic_WNT.hxx
	135	-- In particular, the window backround can be turned off using this method.
	136
	137	ResetFlags ( me : mutable; aFlags : Integer from Standard )
	138	is static;
	139	---Level: Public
	140	---Purpose: Reset specified flags in the extra window data area.
	141	-- Supported flags WDF_* are listed in InterfaceGraphic_WNT.hxx
	142	-- In particular, the window backround can be turned on using this method.
	143
	144
	145	----------------------------
	146	-- Category: Inquire methods
	147	----------------------------
	148
7fd59977	149	IsMapped ( me )
	150	returns Boolean from Standard is virtual;
	151	---Level: Public
	152	---Purpose: Returns True if the window <me> is opened
	153	-- and False if the window is closed.
	154
	155	Ratio ( me )
	156	returns Ratio from Quantity is virtual;
	157	---Level: Public
	158	---Purpose: Returns The Window RATIO equal to the physical
	159	-- WIDTH/HEIGHT dimensions.
	160
7fd59977	161	Position (
	162	me;
	163	X1 : out Integer from Standard;
	164	Y1 : out Integer from Standard;
	165	X2 : out Integer from Standard;
	166	Y2 : out Integer from Standard
	167	)
	168	is virtual;
	169	---Level: Public
	170	---Purpose: Returns The Window POSITION in PIXEL
	171
7fd59977	172	Size (
	173	me;
	174	Width : out Integer from Standard;
	175	Height : out Integer from Standard
	176	)
	177	is virtual;
	178	---Level: Public
	179	---Purpose: Returns The Window SIZE in PIXEL
	180
7fd59977	181	HWindow ( me )
	182	returns Handle from Aspect is static;
	183	---Level: Public
	184	---Purpose: Returns the Windows NT handle of the created window <me>.
	185	---C++: inline
	186
	187	HParentWindow ( me )
	188	returns Handle from Aspect is static;
	189	---Level: Public
	190	---Purpose: Returns the Windows NT handle parent of the created window <me>.
	191	---C++: inline
	192
7fd59977	193	doCreate (
7fd59977	194	me : mutable;
7fd59977	195	aHandle : Handle from Aspect;
	196	aBackColor : NameOfColor from Quantity = Quantity_NOC_MATRAGRAY
	197	) is static private;
	198	---Level: Private
	199	---Purpose: private method
	200
	201	fields
	202
	203	aXLeft : Integer from Standard is protected; -- Window coordinates
	204	aYTop : Integer from Standard is protected;
	205	aXRight : Integer from Standard is protected;
	206	aYBottom : Integer from Standard is protected;
	207	myWClass : WClass from WNT is protected; -- Window class
	208	myHWindow : Handle from Aspect is protected; -- Window handle
	209	myHParentWindow : Handle from Aspect is protected; -- Parent window handle
7fd59977	210	myExtraData : WindowData from WNT is protected; -- additional data
7fd59977	211	myUsrData : Address from Standard is protected;
7fd59977	212
7fd59977	213	end Window;