Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

exotkGUI_GUI Class Reference

Abstract class to execute tasks which require a GUI. More...

#include <exotkGUI_GUI.hxx>

List of all members.

Public Methods

void * operator new (size_t, void *anAddress)
 OCC new. More...

void * operator new (size_t size)
 OCC new. More...

void operator delete (void *anAddress)
 OCC delete. More...

virtual Standard_EXPORT ~exotkGUI_GUI ()
 Destructor. More...

Standard_EXPORT void SetPtr (void *anHandle)
 set a pointer which can be used in the functions. More...

Standard_EXPORT void * Ptr ()
 Returns the sored pointer. More...

Standard_EXPORT void UnSetPtr ()
 Set the sore pointer to NULL. More...

virtual Standard_EXPORT Standard_Boolean SelectColor (const Quantity_Color &aDefaultColor, Quantity_Color &aSelectedColor)=0
 start a SelectColor DialogBox with aDefaultColor. More...

virtual Standard_EXPORT Standard_Boolean SelectMaterial (const Graphic3d_MaterialAspect &aDefaultMaterial, Graphic3d_MaterialAspect &aSelectedMaterial)=0
 start a SelectMaterial DialogBox with aDefaultMaterial. More...

virtual Standard_EXPORT Standard_Boolean SelectTransparency (const Standard_Real aDefaultTransparency, Standard_Real &aTransparency)=0
 start a Select Transparency DialogBox with aDefaultTransparency. More...

virtual Standard_EXPORT void ManagePopup (const Handle_exotkTree_Menu &aMenu, const Standard_Integer &aX, const Standard_Integer &aY)=0
 Manage a popup at the position aX , aY. More...

virtual Standard_EXPORT Standard_Boolean OpenDXFileDialog (TCollection_AsciiString &aFilename)=0
 display an OpenDialogBox for dataexchange. More...

virtual Standard_EXPORT Standard_Boolean SaveDXFileDialog (TCollection_AsciiString &aFilename)=0
 display an SaveDialogBox for dataexchange. More...

virtual Standard_EXPORT void SetProgressBoxRange (const Standard_Integer aBegin, const Standard_Integer anEnd)
 Set the progress box range. More...

virtual Standard_EXPORT void ProgressBoxRange (Standard_Integer &aBegin, Standard_Integer &aEnd)
 Return the Progress Box range. More...

virtual Standard_EXPORT void SetProgressBoxTitle (const TCollection_AsciiString &aTitle)=0
 Set aTitle as title for the progressbox. More...

virtual Standard_EXPORT void SetProgressBoxText (const TCollection_AsciiString &aText)=0
 Set the progressbox text. More...

virtual Standard_EXPORT TCollection_AsciiString ProgressBoxText ()
 Return the progress box text. More...

virtual Standard_EXPORT Standard_Integer ProgressBoxPosition ()=0
 Return the progress box position. More...

virtual Standard_EXPORT Standard_Integer SetProgressBoxPosition (const Standard_Integer aPosition)=0
 Set the progress box position. More...

virtual Standard_EXPORT void HideProgressBox ()=0
 Hide the progress box. More...

virtual Standard_EXPORT void ShowProgressBox ()=0
 Show the progress box. More...

virtual Standard_EXPORT void HideWaitCursor ()=0
 Hide the wait cursor. More...

virtual Standard_EXPORT void ShowWaitCursor ()=0
 Show the wait cursor. More...

Standard_EXPORT const Handle_Standard_Type & DynamicType () const
 Type management. More...

Standard_EXPORT Standard_Boolean IsKind (const Handle_Standard_Type &) const
 Type management. More...


Protected Methods

Standard_EXPORT exotkGUI_GUI ()
 Constructor. More...


Protected Attributes

void * myHandle
TCollection_AsciiString myProgressBoxTitle
TCollection_AsciiString myProgressBoxText
Standard_Integer myProgressBoxPosition
Standard_Integer myBeginRange
Standard_Integer myEndRange

Friends

Standard_EXPORT friend Handle_Standard_Type & exotkGUI_GUI_Type_ ()
 Type management. More...

Detailed Description

Abstract class to execute tasks which require a GUI.

Author:
Stephane Routelous

Definition at line 56 of file exotkGUI_GUI.hxx.

Constructor & Destructor Documentation

exotkGUI_GUI::~exotkGUI_GUI (    )  [virtual]
 

Destructor.

Definition at line 76 of file exotkGUI_GUI.cxx.

exotkGUI_GUI::exotkGUI_GUI (    )  [protected]
 

Constructor.

Definition at line 63 of file exotkGUI_GUI.cxx.

Member Function Documentation

Handle_Standard_Type & exotkGUI_GUI::DynamicType (    )  const
 

Type management.

Returns:
const Handle_Standard_Type&

exotkGUI_GUI::HideProgressBox (    )  [pure virtual]
 

Hide the progress box.

Definition at line 195 of file exotkGUI_GUI.cxx.

References HideWaitCursor().

exotkGUI_GUI::HideWaitCursor (    )  [pure virtual]
 

Hide the wait cursor.

Referenced by HideProgressBox().

exotkGUI_GUI::IsKind (  const Handle_Standard_Type &    )  const
 

Type management.

Returns:
Standard_Boolean
Parameters:
const  Handle_Standard_Type&

exotkGUI_GUI::ManagePopup (  const Handle_exotkTree_Menu &    aMenu,
const Standard_Integer &    aX,
const Standard_Integer &    aY
)  [pure virtual]
 

Manage a popup at the position aX , aY.

Parameters:
aMenu  const Handle_exotkTree_Menu& : the menu to manage
aX  const Standard_Integer& : the X position of the menu
aY  const Standard_Integer& : the Y position of the menu

exotkGUI_GUI::OpenDXFileDialog (  TCollection_AsciiString &    aFilename )  [pure virtual]
 

display an OpenDialogBox for dataexchange.

Returns:
Standard_Boolean
Return values:
aFilename  TCollection_AsciiString&

void exotkGUI_GUI::operator delete (  void *    anAddress )  [inline]
 

OCC delete.

Returns:
inline void
Parameters:
void  *anAddress

Definition at line 89 of file exotkGUI_GUI.hxx.

void * exotkGUI_GUI::operator new (  size_t    size )  [inline]
 

OCC new.

Returns:
inline void*
Parameters:
size_t  size

Definition at line 78 of file exotkGUI_GUI.hxx.

void * exotkGUI_GUI::operator new (  size_t   ,
void *    anAddress
)  [inline]
 

OCC new.

Returns:
inline void*
Parameters:
size_t 
void  * anAddress

Definition at line 67 of file exotkGUI_GUI.hxx.

exotkGUI_GUI::ProgressBoxPosition (    )  [pure virtual]
 

Return the progress box position.

Returns:
Standard_Integer

Definition at line 162 of file exotkGUI_GUI.cxx.

References myProgressBoxPosition.

exotkGUI_GUI::ProgressBoxRange (  Standard_Integer &    aBegin,
Standard_Integer &    aEnd
)  [virtual]
 

Return the Progress Box range.

Return values:
aBegin  Standard_Integer&
aEnd  Standard_Integer&

Definition at line 190 of file exotkGUI_GUI.cxx.

References myBeginRange, and myEndRange.

exotkGUI_GUI::ProgressBoxText (    )  [virtual]
 

Return the progress box text.

Returns:
TCollection_AsciiString

Definition at line 151 of file exotkGUI_GUI.cxx.

References myProgressBoxText.

exotkGUI_GUI::Ptr (    ) 
 

Returns the sored pointer.

Returns:
void*

Definition at line 100 of file exotkGUI_GUI.cxx.

References myHandle.

exotkGUI_GUI::SaveDXFileDialog (  TCollection_AsciiString &    aFilename )  [pure virtual]
 

display an SaveDialogBox for dataexchange.

Returns:
Standard_Boolean
Return values:
aFilename  TCollection_AsciiString&

exotkGUI_GUI::SelectColor (  const Quantity_Color &    aDefaultColor,
Quantity_Color &    aSelectedColor
)  [pure virtual]
 

start a SelectColor DialogBox with aDefaultColor.

Returns:
Standard_Boolean : true if the user choose a color
Parameters:
aDefaultColor  const Quantity_Color&
Return values:
aSelectedColor  Quantity_Color&

exotkGUI_GUI::SelectMaterial (  const Graphic3d_MaterialAspect &    aDefaultMaterial,
Graphic3d_MaterialAspect &    aSelectedMaterial
)  [pure virtual]
 

start a SelectMaterial DialogBox with aDefaultMaterial.

Returns:
Standard_Boolean
Parameters:
aDefaultMaterial  const Graphic3d_MaterialAspect&
Return values:
aSelectedMaterial  Graphic3d_MaterialAspect&

exotkGUI_GUI::SelectTransparency (  const Standard_Real    aDefaultTransparency,
Standard_Real &    aTransparency
)  [pure virtual]
 

start a Select Transparency DialogBox with aDefaultTransparency.

Returns:
Standard_Boolean
Parameters:
aDefaultTransparency  const Standard_Real
Return values:
aTransparency  Standard_Real&

exotkGUI_GUI::SetProgressBoxPosition (  const Standard_Integer    aPosition )  [pure virtual]
 

Set the progress box position.

Returns:
Standard_Integer : the old position
Parameters:
aPosition  const Standard_Integer

Definition at line 175 of file exotkGUI_GUI.cxx.

References myBeginRange, myEndRange, and myProgressBoxPosition.

exotkGUI_GUI::SetProgressBoxRange (  const Standard_Integer    aBegin,
const Standard_Integer    anEnd
)  [virtual]
 

Set the progress box range.

Parameters:
aBegin  const Standard_Integer
anEnd  const Standard_Integer

Definition at line 182 of file exotkGUI_GUI.cxx.

References myBeginRange, and myEndRange.

exotkGUI_GUI::SetProgressBoxText (  const TCollection_AsciiString &    aText )  [pure virtual]
 

Set the progressbox text.

Parameters:
aText  const TCollection_AsciiString&

Definition at line 139 of file exotkGUI_GUI.cxx.

References myProgressBoxText.

exotkGUI_GUI::SetProgressBoxTitle (  const TCollection_AsciiString &    aTitle )  [pure virtual]
 

Set aTitle as title for the progressbox.

Parameters:
aTitle  const TCollection_AsciiString&

Definition at line 126 of file exotkGUI_GUI.cxx.

References myProgressBoxTitle.

exotkGUI_GUI::SetPtr (  void *    anHandle ) 
 

set a pointer which can be used in the functions.

Parameters:
void  * anHandle

Definition at line 88 of file exotkGUI_GUI.cxx.

References myHandle.

exotkGUI_GUI::ShowProgressBox (    )  [pure virtual]
 

Show the progress box.

Definition at line 199 of file exotkGUI_GUI.cxx.

References ShowWaitCursor().

exotkGUI_GUI::ShowWaitCursor (    )  [pure virtual]
 

Show the wait cursor.

Referenced by ShowProgressBox().

exotkGUI_GUI::UnSetPtr (    ) 
 

Set the sore pointer to NULL.

Definition at line 112 of file exotkGUI_GUI.cxx.

References myHandle.

Friends And Related Function Documentation

Handle_Standard_Type & exotkGUI_GUI::exotkGUI_GUI_Type_ (    )  [friend]
 

Type management.

Returns:
friend Handle_Standard_Type&

Member Data Documentation

Standard_Integer exotkGUI_GUI::myBeginRange [protected]
 

the progress box range ( begin )

Definition at line 293 of file exotkGUI_GUI.hxx.

Referenced by ProgressBoxRange(), SetProgressBoxPosition(), and SetProgressBoxRange().

Standard_Integer exotkGUI_GUI::myEndRange [protected]
 

the progress box range ( end )

Definition at line 295 of file exotkGUI_GUI.hxx.

Referenced by ProgressBoxRange(), SetProgressBoxPosition(), and SetProgressBoxRange().

void* exotkGUI_GUI::myHandle [protected]
 

the stored handle

Definition at line 284 of file exotkGUI_GUI.hxx.

Referenced by Ptr(), SetPtr(), and UnSetPtr().

Standard_Integer exotkGUI_GUI::myProgressBoxPosition [protected]
 

the progressbox position

Definition at line 291 of file exotkGUI_GUI.hxx.

Referenced by ProgressBoxPosition(), and SetProgressBoxPosition().

TCollection_AsciiString exotkGUI_GUI::myProgressBoxText [protected]
 

the progressbox text

Definition at line 289 of file exotkGUI_GUI.hxx.

Referenced by ProgressBoxText(), and SetProgressBoxText().

TCollection_AsciiString exotkGUI_GUI::myProgressBoxTitle [protected]
 

the progressbox title

Definition at line 287 of file exotkGUI_GUI.hxx.

Referenced by SetProgressBoxTitle().

The documentation for this class was generated from the following files:
Generated on Wed Jan 23 12:18:33 2002 for exotk by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001