SoQtComponent.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef _SO_QT_COMPONENT_
#define _SO_QT_COMPONENT_
 
#include <Inventor/Qt/OivQtCompat.h>
 
#include <QString>
#include <QPointer>
 
#include <Inventor/Qt/SoQt.h>
#include <Inventor/Gui/SoGuiComponent.h>
 
#include <Inventor/SbBasic.h>
#include <Inventor/SbString.h>
#include <Inventor/SbDict.h>
 
#if defined(__APPLE__)
# undef Display
#endif
 
class SoQtComponent;
 
typedef void SoQtComponentCB( void* userData, SoQtComponent* comp );
 
class  SoQtComponent : public QObject
{
  Q_OBJECT
 
    public:
 
  virtual void show();
 
  virtual void hide();
 
  SbBool isVisible();
 
  virtual QWidget* getWidget() const { return _baseWidget; }
 
  SbBool isTopLevelShell() const { return m_guiComponent->isTopLevelShell(); }
 
  QWidget* getShellWidget() const { return m_guiComponent->isTopLevelShell() ? parentWidget : NULL; }
 
  QWidget* getParentWidget() const { return parentWidget; }
 
  void setSize( const SbVec2s& size );
 
  SbVec2s getSize();
  virtual SbBool setFullScreen( const SbBool enable );
 
  SbBool isFullScreen( void ) const;
 
  void setFullScreenEnable( const SbBool enable );
 
  SbBool isFullScreenEnable(void) const;
 
  inline SbGlContextHelper::Display getDisplay();
 
  void setTitle( const char* newTitle );
 
  void setTitle( const SbString& newTitle );
 
  void setTitle( const QString& newTitle );
 
  const QString getTitle() const;
 
  void setIconTitle( const QString& newIconTitle );
 
  const QString getIconTitle() const;
 
  static SoQtComponent* getComponent( QWidget* widget );
 
  SbString getWidgetName() const;
 
  SbString getClassName() const;
 
  SbString    helpFileName;
 
#ifdef _WIN32
  UINT                helpContextID;
#endif
 
  void setWindowCloseCallback( SoQtComponentCB* func, void* data = NULL )
  { m_windowCloseFunc = func; m_windowCloseData = data; }
 
 
 private:
 
  virtual ~SoQtComponent();
 
  void setFullScreenOn( SbBool enable ) { m_guiComponent->setFullScreen( enable ); };
 
  static void finish();
 
  SoGuiComponent* getGuiComponent() const;
 
Q_SIGNALS:
#ifndef HIDDEN_FROM_DOC
  void visibilityChanged(SbBool visible);
#endif // HIDDEN_FROM_DOC
 
 private:
 
  SoQtComponent( QWidget* parent = NULL,
                 const char* name = NULL,
                 SbBool buildInsideParent = TRUE,
                 SbBool sync = TRUE );
 
  SoQtComponent( QWidget* parent,
                 const char* name,
                 SbBool buildInsideParent,
                 SbBool sync,
                 SoGuiComponent* guiComponent );
 
  void setBaseWidget( QWidget* w );
 
  void setClassName( const char* n ) { m_guiComponent->setClassName( n ); }
 
  virtual void  afterRealizeHook();
 
  //First realize state
  SbBool firstRealize;
 
  virtual SbString  getDefaultWidgetName() const;
  virtual SbString  getDefaultTitle() const;
  virtual SbString  getDefaultIconTitle() const;
 
  //
  // Register widget - should be called by subclasses after
  // they have created their top most widget (which is passed here),
  // and before they build any child widgets. Calling this method
  // ensures that the widgets name and class will be used when
  // calls are made to get X resource values for this widget.
  //
  // *** NOTE ***
  // ALL subclasses should register their top most widget within the
  // component, whether they retrieve resources or not, so that children
  // widgets can get X resources properly.
  // Unregister the widget when the widget is destroyed.
  //
  void registerWidget( QWidget* w );
  void unregisterWidget( QWidget* w );
 
#ifdef _WIN32
  // Utility function to setup logical color palette for 8bit devices
  static HPALETTE _setupColorPalette( HDC );
#endif //_WIN32
 
  virtual bool eventFilter( QObject* object,QEvent *event );
  //
  // This method can be used by subclasses to open a component help
  // card. The name of the file should be supplied withought a path
  // name. By default the file will be searched using:
  // 1) current working directory
  // 2) SO_HELP_DIR environment variable
  // 3) /usr/share/help/Inventor
  // 4) else bring a no help card found dialog
  //
  void openHelpCard( const char* cardName );
 
  static void windowCloseActionCB( SoWidget widget, SoQtComponent* p, void* data );
 
 private:
#ifdef _WIN32
    const char* buildHelpPath( const char* filename );
#endif
   void constructorCommon( QWidget* parent, const char* name, SbBool buildInsideParent, SbBool sync );
 
  //Implementation class for SoXxComponent
  SoGuiComponent* m_guiComponent;
 
  SbBool createdShell; // TRUE if we created that toplevel shell
  QWidget* parentWidget; // topLevel shell if in its own window
  QPointer<QWidget> _baseWidget; // returned by getWidget()
 
  SbVec2s size; // size of the '_baseWidget' and 'shell' (if toplevel)
 
  // The widget dictionary maps widgets to SoXtComponents. It's used
  // by getComponent(), and kept up to date by registerWidget().
  static SbDict* widgetDictionary;
 
  // For fullscreen mode.
  SbBool  wasTopLevel;
 
  QWidget* m_oldParentWidget;
  QRect m_oldGeometry;
  int m_widgetIndex;
 
  // Window close action data
  SoQtComponentCB* m_windowCloseFunc;
  void* m_windowCloseData;
};
 
// Inline routines
 SbGlContextHelper::Display
SoQtComponent::getDisplay()
{
  return SoQt::getDisplay();
}
 
inline const QString
SoQtComponent::getTitle() const
{
  return QString::fromUtf16( m_guiComponent->getTitle().toUtf16() );
}
 
inline const QString
SoQtComponent::getIconTitle() const
{
  return QString::fromUtf16( m_guiComponent->getIconTitle().toUtf16() );
}
 
inline SbString
SoQtComponent::getClassName() const
{
 return m_guiComponent->getClassName();
}
 
inline SbString
SoQtComponent::getWidgetName() const
{
 return m_guiComponent->getWidgetName();
}
 
#endif // _SO_QT_COMPONENT_