b6809b1766c007e2511a714e6412a315faafc874
[occt.git] / src / WNT / WNT_WClass.hxx
1 // Created on: 1996-01-26
2 // Created by: PLOTNIKOV Eugeny
3 // Copyright (c) 1996-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License 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.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _WNT_WClass_HeaderFile
18 #define _WNT_WClass_HeaderFile
19
20 #include <Standard.hxx>
21
22 #if defined(_WIN32) && !defined(OCCT_UWP)
23
24 #include <Standard_Type.hxx>
25 #include <Standard_CString.hxx>
26 #include <Aspect_Handle.hxx>
27 #include <Standard_Address.hxx>
28 #include <MMgt_TShared.hxx>
29 #include <WNT_Uint.hxx>
30 #include <Standard_Integer.hxx>
31 class WNT_ClassDefinitionError;
32 class WNT_Window;
33
34
35 class WNT_WClass;
36 DEFINE_STANDARD_HANDLE(WNT_WClass, MMgt_TShared)
37
38 //! This class defines a Windows NT window class.
39 //! A window in Windows NT is always created based on a
40 //! window class. The window class identifies the window
41 //! procedure that processes messages to the window. Each
42 //! window class has unique name ( character string ). More
43 //! than one window can be created based on a single window
44 //! class. For example, all button windows in Windows NT
45 //! are created based on the same window class. The window
46 //! class defines the window procedure and some other
47 //! characteristics ( background, mouse cursor shape etc. )
48 //! of the windows that are created based on that class.
49 //! When we create a window, we define additional
50 //! characteristics of the window that are unique to that
51 //! window. So, we have to create and register window
52 //! class before creation of any window. Of course, it's possible
53 //! to create a new window class for each window inside
54 //! the Window class and do not use the WClass at all.
55 //! We implemented this class for sake of flexibility of
56 //! event processing.
57 class WNT_WClass : public MMgt_TShared
58 {
59
60 public:
61
62   
63   //! Creates a Windows NT window class and registers it.
64   Standard_EXPORT WNT_WClass(const Standard_CString aClassName, const Standard_Address aWndProc, const WNT_Uint& aStyle, const Standard_Integer aClassExtra = 0, const Standard_Integer aWindowExtra = 0, const Aspect_Handle aCursor = 0, const Aspect_Handle anIcon = 0, const Standard_CString aMenuName = 0);
65   
66   //! Destroys all resources attached to the class
67   Standard_EXPORT ~WNT_WClass();
68   
69   //! Returns address of window procedure.
70     Standard_Address WndProc() const;
71   
72   //! Returns a class name.
73     Standard_CString Name() const;
74   
75   //! Returns a program instance handle.
76     Aspect_Handle Instance() const;
77
78 friend class WNT_Window;
79
80
81   DEFINE_STANDARD_RTTIEXT(WNT_WClass,MMgt_TShared)
82
83 protected:
84
85   Standard_CString lpszName;
86   Aspect_Handle hInstance;
87   Standard_Address lpfnWndProc;
88
89 };
90
91 #include <WNT_WClass.lxx>
92
93 #endif // _WIN32
94 #endif // _WNT_WClass_HeaderFile