Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Attributes
WNT_IconBox Class Reference

This class defines a Windows NT icon box

#include <WNT_IconBox.hxx>

Inheritance diagram for WNT_IconBox:
Inheritance graph
[legend]

Public Member Functions

 WNT_IconBox (const Handle< WNT_GraphicDevice > &aDevice, const Standard_CString aName, const WNT_Dword &aStyle=0, const Standard_Real Xc=0.5, const Standard_Real Yc=0.5, const Quantity_NameOfColor aBkColor=Quantity_NOC_MATRAGRAY)
 Creates an IconBox defined by his Center in DSU.
ALL Icons are loaded from the Icon File Directory Name:
"[$SYMBOL]xxxxxxx[.ifd]"
Warning: Raises if the Position is out of the Screen Space
or the Icon File Directory Name don't exist

Standard_Integer LoadIcons (const Standard_CString Name)
 Loads Icon Box from an Other Icon File Directory Name
and returns the loaded icons number.
Warning: The Icons previously loaded are NOT cleared.

void Show () const
 Shows Icon Box to the screen
Warning: The Icon Box is displayed at the centered position
specified at the creation time and the size depend
of the Icon number really loaded inside.

Standard_Integer UnloadIcons (const Standard_CString Name)
 Unloads All previously loaded Icons in the IconBox
and returns the unloaded icons number.

virtual void Destroy ()
 Destroies the IconBox

 ~WNT_IconBox ()
void AddIcon (const Handle< WNT_Window > &W, const Standard_CString Name, const Standard_Integer aWidth=0, const Standard_Integer aHeight=0)
 Adds an Icon of Size aWidth,aHeight given in PIXEL
to the Icon Box from a FULL Existing Window
NOTE that if aWidth or aHeight is 0 the default icon size is taken.

Standard_Integer SaveIcons () const
 Save all new created Icons as iconname.xwd file in the user
directory and returns the saved icons number.

void SetDim (const Standard_Integer aWidth, const Standard_Integer aHeight)
 Sets dimensions for icons which are visible in the box.

Standard_Integer IconNumber () const
 Returns the Number of Icons loaded in the Icon Box.

Standard_CString IconName (const Standard_Integer Index) const
 Returns the Name of the N ime Icon
Warning: Raises if Index if out of range depending of the
Number of Loaded Icons.

Standard_Boolean IconSize (const Standard_CString Name, Standard_Integer &Width, Standard_Integer &Height) const
 Returns the Pixmap Size attached to the Icon Name
Warning: May return FALSE if Icon doesn't exist in the IconBox.

Aspect_Handle IconPixmap (const Standard_CString Name) const
 Returns the Pixmap attached to the Icon Name
Warning: May return 0 if Icon doesn't exist in the IconBox.

Aspect_Handle IconPixmap (const Standard_CString Name, const Standard_Integer Width, const Standard_Integer Height) const
 Returns the Centered part of the Pixmap of required Size
attached to the Icon Name
Warning: May return 0 if Icon doesn't exist in the IconBox.

WNT_Long HandleEvent (const Aspect_Handle hwnd, const WNT_Uint &uMsg, const WNT_Dword &wParam, const WNT_Dword &lParam)
 routine to process events sent to the icon box

Protected Attributes

Standard_Integer myIconWidth
Standard_Integer myIconHeight
Aspect_Handle myFont
Aspect_Handle myPen
Standard_Boolean myDragging
Standard_Integer myStart
Standard_Integer myIncX
Standard_Integer myIncY
Standard_Integer myNX
Standard_Integer myNY
Standard_Integer myNPos
Standard_Integer myMaxPos

Constructor & Destructor Documentation


Member Function Documentation

virtual void WNT_IconBox::Destroy ( ) [virtual]

Reimplemented from WNT_Window.


Field Documentation


The documentation for this class was generated from the following file: