[occt.git] / src / Xw / Xw_Window.cdl

-- Created on: 1991-11-18
-- Created by: NW,JPB,CAL,GG
-- Copyright (c) 1991-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 Xw

inherits

    Window  from Aspect

uses

    AsciiString              from TCollection,
    Background               from Aspect,
    GradientBackground       from Aspect,
    TypeOfResize             from Aspect,
    Handle                   from Aspect,
    FillMethod               from Aspect,
    GradientFillMethod       from Aspect,
    DisplayConnection_Handle from Aspect,
    PixMap                   from Image,
    NameOfColor              from Quantity,
    Parameter                from Quantity,
    Ratio                    from Quantity,
    Color                    from Quantity,
    ColorMap                 from Xw,
    WindowQuality            from Xw,
    TypeOfVisual             from Xw

raises

    WindowDefinitionError from Aspect,
    WindowError           from Aspect

is

    Create ( theDisplayConnection : DisplayConnection_Handle from Aspect )
    returns mutable Window from Xw
    raises WindowDefinitionError from Aspect;
    ---Level: Public

    Create ( theDisplayConnection : DisplayConnection_Handle from Aspect ;
         aPart1, aPart2 : Integer from Standard ;
         BackColor : NameOfColor from Quantity =
                        Quantity_NOC_MATRAGRAY )
    returns mutable Window from Xw
    ---Level: Public
    ---Purpose: Creates a Window from an X Window defined by his ID
    --      This Xid equals (aPart1 << 16) + aPart2.
    --      A child of this Window is created when the WindowQuality
    --      isn't the same than the parent Window
    --  Trigger: Raises WindowDefinitionError if the connection failed
    --      or if the Position out of the Screen Space
    raises WindowDefinitionError from Aspect ;

    Create ( theDisplayConnection : DisplayConnection_Handle from Aspect ;
         aWindow : Handle from Aspect;
         BackColor : NameOfColor from Quantity =
                        Quantity_NOC_MATRAGRAY )
    returns mutable Window from Xw
    ---Level: Public
    ---Purpose: Creates a Window from an X Window defined by his Xid
    --      A child of this Window is created when the WindowQuality
    --      isn't the same than the parent Window
    --  Trigger: Raises WindowDefinitionError if the connection failed
    --      or if the Position out of the Screen Space
    raises WindowDefinitionError from Aspect ;

    Create ( theDisplayConnection : DisplayConnection_Handle from Aspect ;
             theTitle     : CString from Standard ;
             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 )
    returns mutable Window from Xw
    ---Level: Public
    ---Purpose: Creates a Window defined by his position and size
    --      in pixels from the Parent Window.
    --  Trigger: Raises WindowDefinitionError if the connection failed
    --      or if the Position out of the Screen Space
    raises WindowDefinitionError from Aspect ;

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

    Map ( me ) is virtual;
    ---Level: Public
    ---Purpose: Opens the window <me>.
    ---Category: Methods to modify the class definition

    Unmap ( me ) is virtual;
    ---Level: Public
    ---Purpose: Closes the window <me>.
    ---Category: Methods to modify the class definition

    DoResize ( me )
    returns TypeOfResize from Aspect
    ---Level: Advanced
    ---Purpose: Applies the resizing to the window <me>.
    ---Category: Methods to modify the class definition
    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

    Destroy ( me : mutable )
    ---Level: Advanced
    ---Purpose: Destroies the Window
    --  C++: alias ~
    --  Category: Methods to modify the class definition
    --  Trigger: Raises if Window is not defined properly
    raises WindowError from Aspect is virtual;

    SetCursor ( me ; anId : Integer from Standard ;
        aColor : NameOfColor from Quantity
                    = Quantity_NOC_YELLOW ) is virtual ;
    ---Level: Advanced
    ---Purpose: Changes the current window cursor by anId cursor
    --      in the specified color.
    --      NOTE than anId must be one of /usr/include/X11/cursorfont.h
    --      or 0 for Deactivate the cursor
    ---Category: Methods to modify the class definition

    ----------------------------
    -- 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.
    ---Category: Inquire methods

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

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

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

    XWindow ( me )
    returns Handle from Aspect is static;
    ---Level: Public
    ---Purpose: Returns the X window ID of the created window <me>.
    ---Category: Inquire methods

    XWindow ( me ; aPart1, aPart2 : out Integer from Standard ) is static;
    ---Level: Public
    ---Purpose: Returns the X window ID of the created window <me>.
    --      This Xid equals (aPart1 << 16) + aPart2.

    XParentWindow ( me )
    returns Handle from Aspect is static;
    ---Level: Public
    ---Purpose: Returns the X window ID parent of the created window <me>.
    ---Category: Inquire methods

    XParentWindow ( me ; aPart1, aPart2 : out Integer from Standard ) is static;
    ---Level: Public
    ---Purpose: Returns the X window ID parent of the created window <me>.
    --      This Xid equals (aPart1 << 16) + aPart2.

    XPixmap ( me )
    returns Handle from Aspect is static;
    ---Level: Internal
    ---Purpose: Returns the X pixmap ID of the created window <me>.
    --      If BackingStore () is permitted.
    ---Category: Inquire methods

    PointerPosition ( me ; X, Y : out Integer from Standard )
    returns Boolean from Standard is virtual;
    ---Level: Advanced
    ---Purpose: Returns the Pointer position relatively to the Window <me>
    --      and FALSE if the pointer is outside of the window
    ---Category: Inquire methods

    VisualClass ( me )
    returns TypeOfVisual from Xw is static;
    ---Level: Public
    ---Purpose: Returns the X window Visual class of the created window <me>
    ---Category: Inquire methods

    BackgroundPixel ( me ; aPixel : out Integer from Standard )
    returns Boolean from Standard is static;
    ---Level: Public
     ---Purpose: Returns FALSE when the returned background pixel
    --     value <aPixel> is not defined

    ExtendedWindow ( me )
    returns Address from Standard
    is static protected ;
    ---Level: Internal
    ---Purpose: Returns the ExtendedWindow address of the created window.
    ---Category: Inquire methods

    SetWindow ( me: mutable ; aWindow : Handle from Aspect ;
                BackColor : NameOfColor from Quantity )
    ---Level: Internal
    ---Trigger: Raises if Window is not defined properly
    raises WindowError from Aspect
    is static private ;

    SetWindow ( me: mutable ; Title : CString from Standard ;
                Xc, Yc, Width, Height: Parameter from Quantity ;
                BackColor : NameOfColor from Quantity ;
                Parent : Handle from Aspect )
    ---Level: Internal
    ---Trigger: Raises if Window is not defined properly
    raises WindowError from Aspect
    is static private ;

    PrintError(myclass) is protected;
    ---Purpose: Print last error or raise depending of the error gravity.

    Init( me: mutable ) is private;
    ---Purpose: Initialise the fileds of class

fields

    MyXWindow           : Handle from Aspect is protected ;
    MyXParentWindow     : Handle from Aspect is protected ;
    MyVisualClass       : TypeOfVisual from Xw is protected ;
    MyExtendedDisplay   : Address from Standard is protected ;
    MyExtendedWindow    : Address from Standard is protected ;
    myDisplayConnection : DisplayConnection_Handle from Aspect is protected;

end Window ;
Commit	Line	Data
b311480e	1	-- Created on: 1991-11-18
	2	-- Created by: NW,JPB,CAL,GG
	3	-- Copyright (c) 1991-1999 Matra Datavision
	4	-- Copyright (c) 1999-2012 OPEN CASCADE SAS
7fd59977	5	--
b311480e	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 Xw
7fd59977	22
7fd59977	23	inherits
	24
	25	Window from Aspect
	26
	27	uses
	28
dc3fe572	29	AsciiString from TCollection,
	30	Background from Aspect,
	31	GradientBackground from Aspect,
	32	TypeOfResize from Aspect,
	33	Handle from Aspect,
	34	FillMethod from Aspect,
	35	GradientFillMethod from Aspect,
	36	DisplayConnection_Handle from Aspect,
	37	PixMap from Image,
	38	NameOfColor from Quantity,
	39	Parameter from Quantity,
	40	Ratio from Quantity,
	41	Color from Quantity,
	42	ColorMap from Xw,
	43	WindowQuality from Xw,
	44	TypeOfVisual from Xw
7fd59977	45
	46	raises
	47
	48	WindowDefinitionError from Aspect,
	49	WindowError from Aspect
	50
	51	is
	52
dc3fe572	53	Create ( theDisplayConnection : DisplayConnection_Handle from Aspect )
7fd59977	54	returns mutable Window from Xw
	55	raises WindowDefinitionError from Aspect;
	56	---Level: Public
	57
dc3fe572	58	Create ( theDisplayConnection : DisplayConnection_Handle from Aspect ;
7fd59977	59	aPart1, aPart2 : Integer from Standard ;
7fd59977	60	BackColor : NameOfColor from Quantity =
	61	Quantity_NOC_MATRAGRAY )
	62	returns mutable Window from Xw
	63	---Level: Public
	64	---Purpose: Creates a Window from an X Window defined by his ID
	65	-- This Xid equals (aPart1 << 16) + aPart2.
	66	-- A child of this Window is created when the WindowQuality
	67	-- isn't the same than the parent Window
	68	-- Trigger: Raises WindowDefinitionError if the connection failed
	69	-- or if the Position out of the Screen Space
	70	raises WindowDefinitionError from Aspect ;
	71
dc3fe572	72	Create ( theDisplayConnection : DisplayConnection_Handle from Aspect ;
7fd59977	73	aWindow : Handle from Aspect;
7fd59977	74	BackColor : NameOfColor from Quantity =
	75	Quantity_NOC_MATRAGRAY )
	76	returns mutable Window from Xw
	77	---Level: Public
	78	---Purpose: Creates a Window from an X Window defined by his Xid
	79	-- A child of this Window is created when the WindowQuality
	80	-- isn't the same than the parent Window
	81	-- Trigger: Raises WindowDefinitionError if the connection failed
	82	-- or if the Position out of the Screen Space
	83	raises WindowDefinitionError from Aspect ;
	84
dc3fe572	85	Create ( theDisplayConnection : DisplayConnection_Handle from Aspect ;
7fd59977	86	theTitle : CString from Standard ;
	87	thePxLeft : Integer from Standard ;
	88	thePxTop : Integer from Standard ;
	89	thePxWidth : Integer from Standard ;
	90	thePxHeight : Integer from Standard ;
7fd59977	91	theBackColor : NameOfColor from Quantity = Quantity_NOC_MATRAGRAY ;
	92	theParent : Handle from Aspect = 0 )
	93	returns mutable Window from Xw
	94	---Level: Public
	95	---Purpose: Creates a Window defined by his position and size
	96	-- in pixels from the Parent Window.
	97	-- Trigger: Raises WindowDefinitionError if the connection failed
	98	-- or if the Position out of the Screen Space
	99	raises WindowDefinitionError from Aspect ;
	100
	101	---------------------------------------------------
	102	-- Category: Methods to modify the class definition
	103	---------------------------------------------------
	104
7fd59977	105	Map ( me ) is virtual;
	106	---Level: Public
	107	---Purpose: Opens the window <me>.
	108	---Category: Methods to modify the class definition
	109
	110	Unmap ( me ) is virtual;
	111	---Level: Public
	112	---Purpose: Closes the window <me>.
	113	---Category: Methods to modify the class definition
	114
	115	DoResize ( me )
	116	returns TypeOfResize from Aspect
	117	---Level: Advanced
	118	---Purpose: Applies the resizing to the window <me>.
	119	---Category: Methods to modify the class definition
	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
	129	Destroy ( me : mutable )
	130	---Level: Advanced
	131	---Purpose: Destroies the Window
	132	-- C++: alias ~
	133	-- Category: Methods to modify the class definition
	134	-- Trigger: Raises if Window is not defined properly
	135	raises WindowError from Aspect is virtual;
	136
7fd59977	137	SetCursor ( me ; anId : Integer from Standard ;
	138	aColor : NameOfColor from Quantity
	139	= Quantity_NOC_YELLOW ) is virtual ;
	140	---Level: Advanced
	141	---Purpose: Changes the current window cursor by anId cursor
	142	-- in the specified color.
	143	-- NOTE than anId must be one of /usr/include/X11/cursorfont.h
	144	-- or 0 for Deactivate the cursor
	145	---Category: Methods to modify the class definition
	146
	147	----------------------------
	148	-- Category: Inquire methods
	149	----------------------------
	150
7fd59977	151	IsMapped ( me )
	152	returns Boolean from Standard is virtual;
	153	---Level: Public
	154	---Purpose: Returns True if the window <me> is opened
	155	-- and False if the window is closed.
	156	---Category: Inquire methods
	157
	158	Ratio ( me )
	159	returns Ratio from Quantity is virtual;
	160	---Level: Public
	161	---Purpose: Returns The Window RATIO equal to the physical
	162	-- WIDTH/HEIGHT dimensions
	163	---Category: Inquire methods
	164
7fd59977	165	Position ( me ;
	166	X1, Y1, X2, Y2 : out Integer from Standard ) is virtual;
	167	---Level: Public
	168	---Purpose: Returns The Window POSITION in PIXEL
	169	---Category: Inquire methods
	170
7fd59977	171	Size ( me ;
	172	Width, Height : out Integer from Standard ) is virtual;
	173	---Level: Public
	174	---Purpose: Returns The Window SIZE in PIXEL
	175	---Category: Inquire methods
	176
7fd59977	177	XWindow ( me )
	178	returns Handle from Aspect is static;
	179	---Level: Public
	180	---Purpose: Returns the X window ID of the created window <me>.
	181	---Category: Inquire methods
	182
	183	XWindow ( me ; aPart1, aPart2 : out Integer from Standard ) is static;
	184	---Level: Public
	185	---Purpose: Returns the X window ID of the created window <me>.
	186	-- This Xid equals (aPart1 << 16) + aPart2.
	187
	188	XParentWindow ( me )
	189	returns Handle from Aspect is static;
	190	---Level: Public
	191	---Purpose: Returns the X window ID parent of the created window <me>.
	192	---Category: Inquire methods
	193
	194	XParentWindow ( me ; aPart1, aPart2 : out Integer from Standard ) is static;
	195	---Level: Public
	196	---Purpose: Returns the X window ID parent of the created window <me>.
	197	-- This Xid equals (aPart1 << 16) + aPart2.
	198
	199	XPixmap ( me )
	200	returns Handle from Aspect is static;
	201	---Level: Internal
	202	---Purpose: Returns the X pixmap ID of the created window <me>.
	203	-- If BackingStore () is permitted.
	204	---Category: Inquire methods
	205
	206	PointerPosition ( me ; X, Y : out Integer from Standard )
	207	returns Boolean from Standard is virtual;
	208	---Level: Advanced
	209	---Purpose: Returns the Pointer position relatively to the Window <me>
	210	-- and FALSE if the pointer is outside of the window
	211	---Category: Inquire methods
	212
7fd59977	213	VisualClass ( me )
	214	returns TypeOfVisual from Xw is static;
	215	---Level: Public
	216	---Purpose: Returns the X window Visual class of the created window <me>
	217	---Category: Inquire methods
	218
7fd59977	219	BackgroundPixel ( me ; aPixel : out Integer from Standard )
	220	returns Boolean from Standard is static;
	221	---Level: Public
	222	---Purpose: Returns FALSE when the returned background pixel
	223	-- value <aPixel> is not defined
	224
	225	ExtendedWindow ( me )
	226	returns Address from Standard
	227	is static protected ;
	228	---Level: Internal
	229	---Purpose: Returns the ExtendedWindow address of the created window.
	230	---Category: Inquire methods
	231
7fd59977	232	SetWindow ( me: mutable ; aWindow : Handle from Aspect ;
7fd59977	233	BackColor : NameOfColor from Quantity )
	234	---Level: Internal
	235	---Trigger: Raises if Window is not defined properly
	236	raises WindowError from Aspect
	237	is static private ;
	238
	239	SetWindow ( me: mutable ; Title : CString from Standard ;
	240	Xc, Yc, Width, Height: Parameter from Quantity ;
7fd59977	241	BackColor : NameOfColor from Quantity ;
	242	Parent : Handle from Aspect )
	243	---Level: Internal
	244	---Trigger: Raises if Window is not defined properly
	245	raises WindowError from Aspect
	246	is static private ;
	247
	248	PrintError(myclass) is protected;
	249	---Purpose: Print last error or raise depending of the error gravity.
	250
	251	Init( me: mutable ) is private;
	252	---Purpose: Initialise the fileds of class
	253
	254	fields
	255
7fd59977	256	MyXWindow : Handle from Aspect is protected ;
7fd59977	257	MyXParentWindow : Handle from Aspect is protected ;
7fd59977	258	MyVisualClass : TypeOfVisual from Xw is protected ;
7fd59977	259	MyExtendedDisplay : Address from Standard is protected ;
7fd59977	260	MyExtendedWindow : Address from Standard is protected ;
dc3fe572	261	myDisplayConnection : DisplayConnection_Handle from Aspect is protected;
7fd59977	262
7fd59977	263	end Window ;