Inventor/Wx/SoWxComponent.h

Go to the documentation of this file.

/*=======================================================================
 *** 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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : T.MEHAMLI (Jul 2007)
**=======================================================================*/

#ifndef SO_WX_COMPONENT
#define SO_WX_COMPONENT

//
//  Class: SoWxComponent
//

#include <Inventor/Wx/SoWx.h>
#include <Inventor/Gui/SoGuiComponent.h>

#include <Inventor/SbBasic.h>
#include <Inventor/SbString.h>
#include <Inventor/SbDict.h>

class  SoWxComponent : public wxEvtHandler
{

public:

  virtual void show();

  virtual void hide();
        
  SbBool isVisible();

  wxWindow* getWidget() const { return m_baseWidget; }

  SbBool isTopLevelShell() const { return m_guiComponent->isTopLevelShell(); }

  wxWindow* getShellWidget() const { return m_guiComponent->isTopLevelShell() ? m_parentWidget : NULL; }

  wxWindow* getParentWidget() const { return m_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();

  SoNONUNICODE void setTitle( const char* newTitle );

  void setTitle( const SbString& newTitle );

  SbString getTitle() const { return m_guiComponent->getTitle(); }

  SoNONUNICODE void setIconTitle( const char* newIconTitle );

  void setIconTitle( const SbString& newIconTitle );

  SbString getIconTitle() const 
  { return m_guiComponent->getIconTitle(); }

  static SoWxComponent* getComponent( wxWindow* widget );

  SbString getWidgetName() const { return m_guiComponent->getWidgetName(); } 

  SbString getClassName() const { return m_guiComponent->getClassName(); }

  SbString helpFileName;

#ifdef _WIN32

  UINT helpContextID;
#endif
           
 private:
        
  virtual ~SoWxComponent();
        
  void setFullScreenOn( SbBool enable ) { m_guiComponent->setFullScreen( enable ); }

  static void finish();

  SoGuiComponent* getGuiComponent() const;

 private:
        
  SoWxComponent( wxWindow* parent = NULL,
                 const SbString& name = "", 
                 SbBool buildInsideParent = TRUE,
                 SbBool sync = TRUE );

  SoWxComponent( wxWindow* parent,
                 const SbString& name, 
                 SbBool buildInsideParent,
                 SbBool sync,
                 SoGuiComponent* guiComponent );
        
  void setBaseWidget( wxWindow* w );

  void setClassName( const SbString& n ) { m_guiComponent->setClassName( n ); }
        
  virtual void  afterRealizeHook();

  //First realize state
  SbBool m_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( wxWindow* w );
  void unregisterWidget( wxWindow* w );

#ifdef _WIN32
#ifdef WX_NOPORT
  // Utility function to setup logical color palette for 8bit devices
  static HPALETTE _setupColorPalette( HDC );
#endif // WX_NOPORT
        
  static int ChoosePixelFormatOIV( HDC hdc,int pixelType, int glModes, PIXELFORMATDESCRIPTOR* pfd );
#endif //_WIN32

  //
  // 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)/index.htm
  // 3) $(OIVHOME)/doc/index.htm
  // 4) else open the default browser at "http://www.vsg3d.com/open-inventor-support"
  //
  void openHelpCard( const SbString& cardName );

  //SbBool canSynchronize() { return m_guiComponent->canSynchronize(); }

 private:

   void constructorCommon( wxWindow* parent, const SbString& name, SbBool buildInsideParent, SbBool sync );

  //Implementation class for SoXxComponent
  SoGuiComponent* m_guiComponent;
        
  SbBool m_createdShell; // TRUE if we created that toplevel shell
  wxWindow* m_parentWidget; // topLevel shell if in its own window
  wxWindow* m_baseWidget; // returned by getWidget()
  wxFrame* m_fullScreen;
  SbVec2s m_size; // size of the 'm_baseWidget' and 'shell' (if toplevel)
        
  // The widget dictionary maps widgets to SoWxComponents. It's used
  // by getComponent(), and kept up to date by registerWidget().
  static SbDict* m_widgetDictionary;

  SbBool  m_wasNotTopLevel;
};

// Inline routines
 SbGlContextHelper::Display
SoWxComponent::getDisplay()
{
  return SoWx::getDisplay();
}


#endif // SO_WX_COMPONENT

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/