// This file is generated by WOK (CPPExt). // Please do not edit this file; modify original file instead. // The copyright and license terms as defined for the original file apply to // this header file considered to be the "object code" form of the original source. #ifndef _Xw_IconBox_HeaderFile #define _Xw_IconBox_HeaderFile #ifndef _Standard_HeaderFile #include #endif #ifndef _Standard_DefineHandle_HeaderFile #include #endif #ifndef _Handle_Xw_IconBox_HeaderFile #include #endif #ifndef _Standard_Integer_HeaderFile #include #endif #ifndef _Xw_Window_HeaderFile #include #endif #ifndef _Handle_Xw_GraphicDevice_HeaderFile #include #endif #ifndef _Standard_CString_HeaderFile #include #endif #ifndef _Standard_Real_HeaderFile #include #endif #ifndef _Quantity_NameOfColor_HeaderFile #include #endif #ifndef _Xw_WindowQuality_HeaderFile #include #endif #ifndef _Handle_Xw_Window_HeaderFile #include #endif #ifndef _Standard_Boolean_HeaderFile #include #endif #ifndef _Aspect_Handle_HeaderFile #include #endif class Aspect_WindowDefinitionError; class Aspect_WindowError; class Xw_GraphicDevice; class Xw_Window; //! This class defines a X11 IconBox
//! Warning: The IconBox is not visible at the creation time .
//! To show the Icon Box use the method Show () .
//! In this case the Icon Box appears at the DSU position
//! specified given in [0,1] space .
//! The size of the Icon Box grows depending of the number
//! of the Icons loaded inside .
class Xw_IconBox : public Xw_Window { public: //! Creates a IconBox n Preferred PseudoColor Visual
//! defined by his Center in DSU and connects it to the
//! X server at the first call depending of the GraphicDevice
//! connexion .
//! 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_EXPORT Xw_IconBox(const Handle(Xw_GraphicDevice)& Device,const Standard_CString Name,const Standard_Real Xc = 0.5,const Standard_Real Yc = 0.5,const Quantity_NameOfColor BackColor = Quantity_NOC_MATRAGRAY,const Xw_WindowQuality aQuality = Xw_WQ_SAMEQUALITY); //! Loads Icon Box from an Other Icon File Directory Name
//! and returns the loaded icons number.
//! Warning: The Icons previously loaded are NOT cleared .
Standard_EXPORT Standard_Integer LoadIcons(const Standard_CString Name) ; //! 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_EXPORT void Show() const; //! Unloads All previously loaded Icons in the IconBox
//! and returns the unloaded icons number.
Standard_EXPORT Standard_Integer UnloadIcons(const Standard_CString Name) ; //! Destroies the IconBox
Standard_EXPORT virtual void Destroy() ; ~Xw_IconBox() { Destroy(); } //! 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_EXPORT void AddIcon(const Handle(Xw_Window)& W,const Standard_CString Name,const Standard_Integer aWidth = 0,const Standard_Integer aHeight = 0) ; //! Saves all new created Icons as iconname.xwd file in the user
//! directory and returns the saved icons number.
Standard_EXPORT Standard_Integer SaveIcons() const; //! Returns the Number of Icons loaded in the Icon Box .
Standard_EXPORT Standard_Integer IconNumber() 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_EXPORT Standard_CString IconName(const Standard_Integer Index) const; //! Returns the Pixmap Size attached to the Icon Name
//! Warning: May return FALSE if Icon doesn't exist in the IconBox .
Standard_EXPORT Standard_Boolean IconSize(const Standard_CString Name,Standard_Integer& Width,Standard_Integer& Height) const; //! Returns the Pixmap attached to the Icon Name
//! Warning: May return 0 if Icon doesn't exist in the IconBox .
Standard_EXPORT Aspect_Handle IconPixmap(const Standard_CString Name) 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 .
Standard_EXPORT Aspect_Handle IconPixmap(const Standard_CString Name,const Standard_Integer Width,const Standard_Integer Height) const; DEFINE_STANDARD_RTTI(Xw_IconBox) protected: private: Standard_Integer MyNumberOfIcons; }; // other Inline functions and methods (like "C++: function call" methods) #endif