[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-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.

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
	4	-- Copyright (c) 1999-2012 OPEN CASCADE SAS
	5	--
	6	-- The content of this file is subject to the Open CASCADE Technology Public
	7	-- License Version 6.5 (the "License"). You may not use the content of this file
	8	-- except in compliance with the License. Please obtain a copy of the License
	9	-- at http://www.opencascade.org and read it completely before using this file.
	10	--
	11	-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
	12	-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
	13	--
	14	-- The Original Code and all software distributed under the License is
	15	-- distributed on an "AS IS" basis, without warranty of any kind, and the
	16	-- Initial Developer hereby disclaims all such warranties, including without
	17	-- limitation, any warranties of merchantability, fitness for a particular
	18	-- purpose or non-infringement. Please see the License for the specific terms
	19	-- and conditions governing the rights and limitations under the License.
	20
7fd59977	21	class Window from WNT inherits Window from Aspect
	22
	23	---Purpose: This class defines Windows NT window
7fd59977	24
	25	uses
	26
	27	Handle from Aspect,
7fd59977	28	TypeOfResize from Aspect,
7fd59977	29	NameOfColor from Quantity,
7fd59977	30	Color from Quantity,
7fd59977	31	Ratio from Quantity,
7fd59977	32	WClass from WNT,
7fd59977	33	Uint from WNT,
7fd59977	34	Dword from WNT,
dc3fe572	35	WindowData from WNT
7fd59977	36
	37	raises
	38
	39	WindowDefinitionError from Aspect,
	40	WindowError from Aspect
	41
	42	is
dc3fe572	43
dc3fe572	44	Create (theTitle : CString from Standard;
7fd59977	45	theClass : WClass from WNT;
	46	theStyle : Dword from WNT;
	47	thePxLeft : Integer from Standard;
	48	thePxTop : Integer from Standard;
	49	thePxWidth : Integer from Standard;
	50	thePxHeight : Integer from Standard;
	51	theBackColor : NameOfColor from Quantity = Quantity_NOC_MATRAGRAY;
	52	theParent : Handle from Aspect = 0;
	53	theMenu : Handle from Aspect = 0;
	54	theClientStruct : Address from Standard = 0)
	55	returns mutable Window from WNT
	56	---Level: Public
	57	---Purpose: Creates a Window defined by his position and size
	58	-- in pixles from the Parent Window.
	59	-- Trigger: Raises WindowDefinitionError if the Position out of the
	60	-- Screen Space or the window creation failed.
	61	raises WindowDefinitionError from Aspect;
	62
	63	Create (
7fd59977	64	aHandle : Handle from Aspect;
	65	aBackColor : NameOfColor from Quantity = Quantity_NOC_MATRAGRAY
	66	)
	67	returns mutable Window from WNT;
	68	---Level: Public
	69	---Purpose: Creates a Window based on the existing window handle.
	70	-- This handle equals ( aPart1 << 16 ) + aPart2.
	71
	72	Create (
7fd59977	73	aPart1 : Integer from Standard;
	74	aPart2 : Integer from Standard;
	75	aBackColor : NameOfColor from Quantity = Quantity_NOC_MATRAGRAY
	76	)
	77	returns mutable Window from WNT;
	78	---Level: Public
	79	---Purpose: Creates a Window based on the existing window <aHandle>.
	80
	81	Destroy ( me : mutable )
	82	is virtual;
	83	---Level: Public
	84	---Purpose: Destroies the Window and all resourses attached to it.
	85	---C++: alias ~
	86
	87
	88	---------------------------------------------------
	89	-- Category: Methods to modify the class definition
	90	---------------------------------------------------
	91
7fd59977	92	SetCursor ( me; aCursor : Handle from Aspect )
	93	is static;
	94	---Level: Public
	95	---Purpose: Sets cursor <aCursor> for ENTIRE WINDOW CLASS to which
	96	-- the Window belongs.
	97
7fd59977	98	Map ( me )
	99	is virtual;
	100	---Level: Public
	101	---Purpose: Opens the window <me>.
	102
	103	Map ( me; aMapMode : Integer from Standard )
	104	is static;
	105	---Level: Public
	106	---Purpose: Opens a window <me> according to <aMapMode>.
	107	-- This method is specific to Windows NT.
	108	-- <aMapMode> can be one of SW_xxx constants defined
	109	-- in <windows.h>. See documentation.
	110
	111	Unmap ( me )
	112	is virtual;
	113	---Level: Public
	114	---Purpose: Closes the window <me>.
	115
	116	DoResize ( me )
	117	returns TypeOfResize from Aspect
	118	---Level: Public
	119	---Purpose: Applies the resizing to the window <me>.
	120	raises WindowError from Aspect is virtual;
	121
	122	DoMapping ( me ) returns Boolean from Standard
	123	raises WindowError from Aspect is virtual;
	124	---Level: Advanced
	125	---Purpose: Apply the mapping change to the window <me>
	126	-- and returns TRUE if the window is mapped at screen.
	127	---Category: Methods to modify the class definition
	128
7fd59977	129	SetPos ( me : mutable; X, Y, X1, Y1 : Integer from Standard )
	130	is static;
	131	---Level: Internal
	132	---Purpose: Changes variables due to window position.
	133
	134	SetFlags ( me : mutable; aFlags : Integer from Standard )
	135	is static;
	136	---Level: Public
	137	---Purpose: Sets user defined flags in the extra window data area.
	138	-- Supported flags WDF_* are listed in InterfaceGraphic_WNT.hxx
	139	-- In particular, the window backround can be turned off using this method.
	140
	141	ResetFlags ( me : mutable; aFlags : Integer from Standard )
	142	is static;
	143	---Level: Public
	144	---Purpose: Reset specified flags in the extra window data area.
	145	-- Supported flags WDF_* are listed in InterfaceGraphic_WNT.hxx
	146	-- In particular, the window backround can be turned on using this method.
	147
	148
	149	----------------------------
	150	-- Category: Inquire methods
	151	----------------------------
	152
7fd59977	153	IsMapped ( me )
	154	returns Boolean from Standard is virtual;
	155	---Level: Public
	156	---Purpose: Returns True if the window <me> is opened
	157	-- and False if the window is closed.
	158
	159	Ratio ( me )
	160	returns Ratio from Quantity is virtual;
	161	---Level: Public
	162	---Purpose: Returns The Window RATIO equal to the physical
	163	-- WIDTH/HEIGHT dimensions.
	164
7fd59977	165	Position (
	166	me;
	167	X1 : out Integer from Standard;
	168	Y1 : out Integer from Standard;
	169	X2 : out Integer from Standard;
	170	Y2 : out Integer from Standard
	171	)
	172	is virtual;
	173	---Level: Public
	174	---Purpose: Returns The Window POSITION in PIXEL
	175
7fd59977	176	Size (
	177	me;
	178	Width : out Integer from Standard;
	179	Height : out Integer from Standard
	180	)
	181	is virtual;
	182	---Level: Public
	183	---Purpose: Returns The Window SIZE in PIXEL
	184
7fd59977	185	HWindow ( me )
	186	returns Handle from Aspect is static;
	187	---Level: Public
	188	---Purpose: Returns the Windows NT handle of the created window <me>.
	189	---C++: inline
	190
	191	HParentWindow ( me )
	192	returns Handle from Aspect is static;
	193	---Level: Public
	194	---Purpose: Returns the Windows NT handle parent of the created window <me>.
	195	---C++: inline
	196
7fd59977	197	doCreate (
7fd59977	198	me : mutable;
7fd59977	199	aHandle : Handle from Aspect;
	200	aBackColor : NameOfColor from Quantity = Quantity_NOC_MATRAGRAY
	201	) is static private;
	202	---Level: Private
	203	---Purpose: private method
	204
	205	fields
	206
	207	aXLeft : Integer from Standard is protected; -- Window coordinates
	208	aYTop : Integer from Standard is protected;
	209	aXRight : Integer from Standard is protected;
	210	aYBottom : Integer from Standard is protected;
	211	myWClass : WClass from WNT is protected; -- Window class
	212	myHWindow : Handle from Aspect is protected; -- Window handle
	213	myHParentWindow : Handle from Aspect is protected; -- Parent window handle
7fd59977	214	myExtraData : WindowData from WNT is protected; -- additional data
7fd59977	215	myUsrData : Address from Standard is protected;
7fd59977	216
7fd59977	217	end Window;