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

exotkGUI Class Reference

Utility class for GUI actions. More...

#include <exotkGUI.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...


Static Public Methods

Standard_EXPORT void SetGUI (const Handle_exotkGUI_GUI &aGUI)
 Set aGui as the instance of the GUI class used by the application. More...

Standard_EXPORT TopoDS_Shape Sample ()
 Return the shape sample used in the dialog boxes. More...

Standard_EXPORT Standard_Boolean SetPtr (void *anHandle)
 set anHandle as generic pointer to be used in the GUI related functions. More...

Standard_EXPORT Standard_Boolean Ptr (void *anHandle)
 Return the generic pointer to be used in the GUI related functions. More...

Standard_EXPORT Standard_Boolean UnSetPtr ()
 Unset the geneiric pointer ( set it to null ). More...

Standard_EXPORT Standard_Boolean ManagePopup (const Handle_exotkTree_Menu &aMenu, const Standard_Integer &aX, const Standard_Integer &aY)
 Manage the Popup menu aMenu at aX and aY. More...

Standard_EXPORT Standard_Boolean SelectColor (const Quantity_Color &aDefaultColor, Quantity_Color &aSelectedColor, Standard_Boolean &aColorIsSelected)
 Function to select a color. More...

Standard_EXPORT Standard_Boolean SelectMaterial (const Graphic3d_MaterialAspect &aDefaultMaterial, Graphic3d_MaterialAspect &aSelectedMaterial, Standard_Boolean &aMaterialIsSelected)
 Function to select a material. More...

Standard_EXPORT Standard_Boolean SelectTransparency (const Standard_Real aDefaultTransparency, Standard_Real &aSelectedTransparency, Standard_Boolean &aMaterialIsSelected)
 Function to select a transparency. More...

Standard_EXPORT Standard_Boolean OpenDXFileDialog (TCollection_AsciiString &aFilename)
 Function to select a file for dataExchange Open. More...

Standard_EXPORT Standard_Boolean SaveDXFileDialog (TCollection_AsciiString &aFilename)
 Function to select a file for DataExchange Save. More...

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

Standard_EXPORT Standard_Boolean ProgressBoxRange (Standard_Integer &aBegin, Standard_Integer &anEnd)
 Return the ProgressBox range. More...

Standard_EXPORT Standard_Boolean SetProgressBoxTitle (const TCollection_AsciiString &aTitle)
 Set the progress box title. More...

Standard_EXPORT Standard_Boolean SetProgressBoxText (const TCollection_AsciiString &aText)
 Set the progress box text. More...

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

Standard_EXPORT Standard_Boolean ProgressBoxPosition (Standard_Integer &aPosition)
 Return the progress box position. More...

Standard_EXPORT Standard_Boolean SetProgressBoxPosition (const Standard_Integer aPosition)
 Set the progress box position. More...

Standard_EXPORT Standard_Boolean HideProgressBox ()
 Hide the progress box. More...

Standard_EXPORT Standard_Boolean ShowProgressBox ()
 Show the progress box. More...

Standard_EXPORT Standard_Boolean HideWaitCursor ()
 Hide the wait cursor. More...

Standard_EXPORT Standard_Boolean ShowWaitCursor ()
 Show the wait cursor. More...

Detailed Description

Utility class for GUI actions.

Author:
Stephane Routelous

Definition at line 53 of file exotkGUI.hxx.

Member Function Documentation

exotkGUI::HideProgressBox (    )  [static]
 

Hide the progress box.

Returns:
Standard_Boolean

Definition at line 338 of file exotkGUI.cxx.

Referenced by exotkAF_Document::OpenFile().

exotkGUI::HideWaitCursor (    )  [static]
 

Hide the wait cursor.

Returns:
Standard_Boolean

Definition at line 385 of file exotkGUI.cxx.

exotkGUI::ManagePopup (  const Handle_exotkTree_Menu &    aMenu,
const Standard_Integer &    aX,
const Standard_Integer &    aY
)  [static]
 

Manage the Popup menu aMenu at aX and aY.

Returns:
Standard_Boolean
Parameters:
aMenu  const Handle_exotkTree_Menu&
aX  const Standard_Integer&
aY  const Standard_Integer&

Definition at line 356 of file exotkGUI.cxx.

exotkGUI::OpenDXFileDialog (  TCollection_AsciiString &    aFilename )  [static]
 

Function to select a file for dataExchange Open.

Returns:
Standard_Boolean
Return values:
aFilename  TCollection_AsciiString& : empty if the user cancels the action

Definition at line 276 of file exotkGUI.cxx.

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

OCC delete.

Returns:
inline void
Parameters:
void  *anAddress

Definition at line 86 of file exotkGUI.hxx.

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

OCC new.

Returns:
inline void*
Parameters:
size_t  size

Definition at line 75 of file exotkGUI.hxx.

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

OCC new.

Returns:
inline void*
Parameters:
size_t 
void  * anAddress

Definition at line 64 of file exotkGUI.hxx.

exotkGUI::ProgressBoxPosition (  Standard_Integer &    aPosition )  [static]
 

Return the progress box position.

Returns:
Standard_Boolean
Return values:
aPosition  Standard_Integer&

Definition at line 320 of file exotkGUI.cxx.

exotkGUI::ProgressBoxRange (  Standard_Integer &    aBegin,
Standard_Integer &    anEnd
)  [static]
 

Return the ProgressBox range.

Returns:
Standard_Boolean
Return values:
aBegin  Standard_Integer&
anEnd  Standard_Integer&

Definition at line 376 of file exotkGUI.cxx.

exotkGUI::ProgressBoxText (    )  [static]
 

Return the progress box text.

Returns:
TCollection_AsciiString

Definition at line 310 of file exotkGUI.cxx.

exotkGUI::Ptr (  void *    anHandle )  [static]
 

Return the generic pointer to be used in the GUI related functions.

Returns:
Standard_Boolean
Return values:
anHandle  void*

Definition at line 231 of file exotkGUI.cxx.

exotkGUI::Sample (    )  [static]
 

Return the shape sample used in the dialog boxes.

Returns:
TopoDS_Shape

Definition at line 187 of file exotkGUI.cxx.

References common_blend(), and cut_blend().

exotkGUI::SaveDXFileDialog (  TCollection_AsciiString &    aFilename )  [static]
 

Function to select a file for DataExchange Save.

Returns:
Standard_Boolean
Return values:
aFilename  TCollection_AsciiString& : empty if the user cancels the action

Definition at line 284 of file exotkGUI.cxx.

exotkGUI::SelectColor (  const Quantity_Color &    aDefaultColor,
Quantity_Color &    aSelectedColor,
Standard_Boolean &    aColorIsSelected
)  [static]
 

Function to select a color.

Returns:
Standard_Boolean
Parameters:
aDefaultColor  const Quantity_Color&
Return values:
aSelectedColor  Quantity_Color&
aColorIsSelected  Standard_Boolean& : false if the user cancels the action

Definition at line 249 of file exotkGUI.cxx.

Referenced by exotkAF_ViewBackgroundColorMenuNode::Execute().

exotkGUI::SelectMaterial (  const Graphic3d_MaterialAspect &    aDefaultMaterial,
Graphic3d_MaterialAspect &    aSelectedMaterial,
Standard_Boolean &    aMaterialIsSelected
)  [static]
 

Function to select a material.

Returns:
Standard_Boolean
Parameters:
aDefaultMaterial  const Graphic3d_MaterialAspect&
aSelectedMaterial  Graphic3d_MaterialAspect&
aMaterialIsSelected  Standard_Boolean& : false if the user cancels the action

Definition at line 258 of file exotkGUI.cxx.

Referenced by exotkAIS_MaterialMenuNode::Execute().

exotkGUI::SelectTransparency (  const Standard_Real    aDefaultTransparency,
Standard_Real &    aSelectedTransparency,
Standard_Boolean &    aMaterialIsSelected
)  [static]
 

Function to select a transparency.

Returns:
Standard_Boolean
Parameters:
aDefaultTransparency  const Standard_Real
aSelectedTransparency  Standard_Real&
aMaterialIsSelected  Standard_Boolean& : false if the user cancels the action

Definition at line 267 of file exotkGUI.cxx.

Referenced by exotkAIS_TransparencyMenuNode::Execute().

exotkGUI::SetGUI (  const Handle_exotkGUI_GUI &    aGUI )  [static]
 

Set aGui as the instance of the GUI class used by the application.

Parameters:
aGUI  const Handle_exotkGUI_GUI&

Definition at line 94 of file exotkGUI.cxx.

exotkGUI::SetProgressBoxPosition (  const Standard_Integer    aPosition )  [static]
 

Set the progress box position.

Returns:
Standard_Boolean
Parameters:
aPosition  const Standard_Integer

Definition at line 329 of file exotkGUI.cxx.

Referenced by exotkAF_Document::OpenFile().

exotkGUI::SetProgressBoxRange (  const Standard_Integer    aBegin,
const Standard_Integer    anEnd
)  [static]
 

Set the progress box range.

Returns:
Standard_Boolean
Parameters:
aBegin  const Standard_Integer
anEnd  const Standard_Integer

Definition at line 366 of file exotkGUI.cxx.

Referenced by exotkAF_Document::OpenFile().

exotkGUI::SetProgressBoxText (  const TCollection_AsciiString &    aText )  [static]
 

Set the progress box text.

Returns:
Standard_Boolean
Parameters:
aText  const TCollection_AsciiString&

Definition at line 301 of file exotkGUI.cxx.

Referenced by exotkAF_Document::OpenFile().

exotkGUI::SetProgressBoxTitle (  const TCollection_AsciiString &    aTitle )  [static]
 

Set the progress box title.

Returns:
Standard_Boolean
Parameters:
aTitle  const TCollection_AsciiString&

Definition at line 292 of file exotkGUI.cxx.

Referenced by exotkAF_Document::OpenFile().

exotkGUI::SetPtr (  void *    anHandle )  [static]
 

set anHandle as generic pointer to be used in the GUI related functions.

Returns:
Standard_Boolean : true if a exotkGUI_GUI exists
Parameters:
anHandle  void*

Definition at line 222 of file exotkGUI.cxx.

exotkGUI::ShowProgressBox (    )  [static]
 

Show the progress box.

Returns:
Standard_Boolean

Definition at line 347 of file exotkGUI.cxx.

Referenced by exotkAF_Document::OpenFile().

exotkGUI::ShowWaitCursor (    )  [static]
 

Show the wait cursor.

Returns:
Standard_Boolean

Definition at line 394 of file exotkGUI.cxx.

exotkGUI::UnSetPtr (    )  [static]
 

Unset the geneiric pointer ( set it to null ).

Returns:
Standard_Boolean

Definition at line 240 of file exotkGUI.cxx.

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