SoWinComponent.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_WIN_COMPONENT_H_
#define _SO_WIN_COMPONENT_H_
 
#include <Inventor/Win/SoWinBeginStrict.h>
#include <windows.h>
#include <Inventor/Win/SoWin.h>
#include <Inventor/Win/SoWinDef.h>
#include <Inventor/Gui/SoGuiComponent.h>
 
#include <Inventor/SbLinear.h>
#include <Inventor/SbString.h>
 
class SbDict;
class SoWinComponent;
class SoCallbackList;
class SoWinComponentP;
 
typedef void SoWinComponentCB( void* userData, SoWinComponent* comp );
typedef void SoWinComponentVisibilityCB( void* userData, SbBool visibleFlag );
 
class  SoWinComponent
{
    friend class SoWinComponentP;
  
 public:
SoDEPRECATED SoNONUNICODE static void displayHelp(const char*  filename, UINT contextID);
  SoDEPRECATED static void displayHelp(const SbString& filename, UINT contextID);
 
  virtual void show();
 
  virtual void hide();
    
  SbBool isVisible();
    
  SoWidget getWidget() const { return _baseWidget; }
    
  SbBool isTopLevelShell() const { return m_guiComponent->isTopLevelShell(); }
 
  SoWidget getShellWidget() const { return m_guiComponent->isTopLevelShell() ? parentWidget : NULL; }
 
  SoWidget getParentWidget() const { return parentWidget; }
 
  void setSize( const SbVec2s& size );
 
  SbVec2s getSize();
 
  SbBool setFullScreen( const SbBool enable );
 
  SbBool isFullScreen() const;
 
  void setFullScreenEnable( const SbBool enable );
 
  SbBool isFullScreenEnable( void ) const;
 
  UINT* getDisplay() { return NULL; }
 
  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(); }
 
  void setWindowCloseCallback( SoWinComponentCB *func, void* data = NULL )
    { windowCloseFunc = func; windowCloseData = data; }
 
  static SoWinComponent* getComponent( SoWidget w );
 
  SbString getWidgetName() const { return m_guiComponent->getWidgetName(); } 
 
  SbString getClassName() const { return m_guiComponent->getClassName(); }
 
  SbString helpFileName;
 
  UINT helpContextID;
 
  SbString helpContextString;
 
  virtual ~SoWinComponent();
 
 private:
 
  // Deprecated. Replaced by getWidget().
  SoWidget baseWidget() const { return getWidget(); }
 
  static void exitClass();
 
  // Returns the current guiComponent
  SoGuiComponent* getGuiComponent() const;
 
 private:
  //
  // If `parent` widget is suplied AND `buildInsideParent` is TRUE, this
  // component will build inside the given parent widget, else
  // it will create its own topLevelShell widget (component resides in 
  // its own window).
  // The topLevelShell can either be created under the given
  // parent shell (`parent` != NULL) or under the main window.
  //
  // The name is used for looking up X resource values. If NULL,
  // then this component inherits resource values defined for its class.
  //
  // Calling setBaseWidget is needed for looking up Xt like 
  // resources in the widget tree. It will use the class name of
  // the Inventor component (e.g. SoWinRenderArea) instead of
  // the class name of the Motif widget this component employs
  // (e.g. XmForm).
  // 
  // Thus apps are able to do this in their app-defaults file:
  //
  // *SoWinRenderArea*BackgroundColor: salmon
  //
  SoWinComponent( SoWidget parent = NULL,
                  const SbString& name = "", 
                  SbBool buildInsideParent = TRUE,
                  SbBool sync = TRUE );
 
  SoWinComponent( SoWidget parent,
                  const SbString& name, 
                  SbBool buildInsideParent,
                  SbBool sync,
                  SoGuiComponent* guiComponent );
 
  // Subclasses need to call this method passing the top most
  // widget after it has been created.
  void setBaseWidget( SoWidget w );
  
  // Subclasses need to set the class name in the constructor
  // before the widget is built.
  void setClassName( const SbString& n ) { m_guiComponent->setClassName( n ); }
  
  // this routine is called whenever the top level shell widget receives
  // a close action (WM_DELETE_WINDOW message) from the window manager.
  // Instead of destroying the widget (default shell behavior) this
  // routine is used, which by default calls exit(0) if it is the main
  // window else calls hide() on the component.
  //
  virtual void windowCloseAction();
  
  // Support for doing things right after the widget is realized
  // for the first time. 
  // The base class will set the window and icon title for shell widgets.
  virtual void afterRealizeHook();
  SbBool firstRealize;
  
  //
  // Subclasses should redefine these routines to return the appropriate
  // default information. Those are used when creating the widget to set 
  // the name (used for resources), window title and window icon
  // name. Those default values are only used if the user didn't 
  // explicitly specify them.
  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( SoWidget w );
  void unregisterWidget( SoWidget w );
  
  // subclasses can add a callback to be called whenever the component
  // becomes visible or become hidden (like when it is iconified).
  // Sublcasses should use this to attach or detach any sensors they
  // have, or stop any ongoing anymation.
  void addVisibilityChangeCallback( SoWinComponentVisibilityCB* func, 
                                    void* userData = NULL );
  void removeVisibilityChangeCallback( SoWinComponentVisibilityCB* func, 
                                       void* userData = NULL );
  
  //
  // This method can be used by subclasses to open a component help
  // card. The name of the file should be supplied without 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
  //SoDEPRECATED void openHelpCard(const SbString& cardName);
  
  static void openHelpPage( const SbString& helpPage );
 
  // Used to factorize displayHelp and openHelpCard methods.SoDEPRECATED static void internalDisplayHelp(const SbString& path, UINT contextID, HWND hWndMain = NULL);
 
  SoWidget buildFormWidget( SoWidget parent );
  
  void setResize( SbBool nResize ) { m_nResizeBaseWidget = nResize; }
  SbBool getResize() { return m_nResizeBaseWidget ; }
 
  // Utility function to setup logical color palette for 8bit devices
  static HPALETTE _setupColorPalette( HDC );
  
  void unSubclassDialog( Hwnd hWnd );
  void subclassDialog( Hwnd hWnd );
  void drawDialogIcon( Hwnd hWnd );
  
  static LRESULT CALLBACK dlgWndProc( Hwnd hwnd, UINT message,
                                      WPARAM wParam, LPARAM lParam );
  static Hwnd getMDIAncestor( Hwnd win );
  
  // If parent of glxMgrWindow is MDI we need to call DefMDIChildProc
  // in mgrWindowProc instead of DefWindowProc
  SbBool m_nParentIsMDI;
  
  HICON hDlgIcon;
  
  char* windowName;
  SbBool buildInside;
  
  static void widgetStructureNotifyCB( SoWidget w, SoWinComponent* c, XEvent* e, Boolean* b );
  static void windowCloseActionCB(SoWidget, SoWinComponent *, void *);
  static int ChoosePixelFormatOIV( HDC hdc, int pixelType, int glModes, PIXELFORMATDESCRIPTOR* pfd );
 
 private:
 
   void constructorCommon( SoWidget parent, const SbString& name, SbBool buildInsideParent, SbBool sync );
 
  // widgetDestroyed is called when the widget is destroyed.
  // There is no way to reconstruct the widget tree, so calling
  // this simply generates an error. The component should be
  // deleted to dispose of the widget.
  virtual void widgetDestroyed();
 
  SbBool createdShell; // TRUE if we created that toplevel shell
  SoWidget parentWidget; // topLevel shell if in its own window
  SoWidget _baseWidget; // returned by getWidget()
  SbVec2s size; // size of the '_baseWidget' and 'shell' (if toplevel)
  
  // visibiltity stuff
  SbBool visibleState;
  SbBool ShellMapped, widgetMapped;
  SoCallbackList *visibiltyCBList;
  void checkForVisibilityChange();
  
  // For fullscreen.
  SbVec2s viewerPos;
  SbVec2s viewerSize;
  long style, extStyle;
  
  static void shellStructureNotifyCB( SoWidget w, SoWinComponent* c, XEvent* e, Boolean* b );
  static void widgetDestroyedCB( SoWidget w, XtPointer p1, XtPointer p2 );
  
  // window close action data
  SoWinComponentCB* windowCloseFunc;
  void* windowCloseData;
 
  // The widget dictionary maps widgets to SoWinComponents. It's used
  // by getComponent(), and kept up to date by registerWidget().
  static SbDict* widgetDictionary;
  
  // If we subclass our parent, remember parent's original wndproc so we
  // can pass messages along to it.
  WNDPROC parentWndProc;
  WNDPROC origDlgWndProc;
 
  // if this is true, then SoWinComponent resizes the base widget when
  // it receive WM_SIZE, otherwise no resize
  SbBool m_nResizeBaseWidget;
  
  static void OnWmSize( Hwnd hwnd, UINT message,
                        WPARAM wParam, LPARAM lParam );
  static void OnWmPaint( Hwnd hwnd, UINT message,
                         WPARAM wParam, LPARAM lParam );
  static void OnWmDestroy( Hwnd hwnd, UINT message,
                           WPARAM wParam, LPARAM lParam );
  
  // Window proc for "subclassing" parent shell window (to track size changes)
  static LRESULT CALLBACK componentWndProc( Hwnd hwnd, UINT message,
                                            WPARAM wParam, LPARAM lParam );
  static LRESULT CALLBACK formWindowProc( Hwnd hwnd, UINT message,
                                          WPARAM wParam, LPARAM lParam );
 
  //Implementation class for SoXxComponent
  SoGuiComponent* m_guiComponent;
};
 
#include <Inventor/Win/SoWinEndStrict.h>
 
#endif // _SO_WIN_COMPONENT_H_