SoQt  1.6.2
Coin3D GUI toolkit binding
No Matches
SoQtComponent Class Reference

The SoQtComponent class is the base class for all GUI components. More...

#include <Inventor/Qt/SoQtComponent.h>

Inheritance diagram for SoQtComponent:
SoQtObject SoQtGLWidget SoQtRenderArea SoQtViewer SoQtFullViewer SoQtConstrainedViewer SoQtExaminerViewer SoQtPlaneViewer SoQtFlyViewer

Public Member Functions

virtual ~SoQtComponent ()
QWidget * getBaseWidget (void) const
const char * getClassName (void) const
const char * getIconTitle (void) const
QWidget * getParentWidget (void) const
QWidget * getShellWidget (void) const
SbVec2s getSize (void) const
const char * getTitle (void) const
QWidget * getWidget (void) const
const char * getWidgetName (void) const
virtual void hide (void)
SbBool isFullScreen (void) const
SbBool isTopLevelShell (void) const
SbBool isVisible (void)
virtual void setComponentCursor (const SoQtCursor &cursor)
SbBool setFullScreen (const SbBool onoff)
void setIconTitle (const char *const title)
void setSize (const SbVec2s size)
void setTitle (const char *const title)
void setWindowCloseCallback (SoQtComponentCB *const func, void *const user=NULL)
virtual void show (void)
- Public Member Functions inherited from SoQtObject
virtual SoType getTypeId (void) const =0
SbBool isOfType (SoType type) const

Static Public Member Functions

static SoQtComponentgetComponent (QWidget *widget)
static void initClasses (void)
static void setWidgetCursor (QWidget *w, const SoQtCursor &cursor)
- Static Public Member Functions inherited from SoQtObject
static SoType getClassTypeId (void)
static void init (void)
static void initClass (void)

Protected Member Functions

 SoQtComponent (QWidget *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE)
void addVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user=NULL)
virtual void afterRealizeHook (void)
virtual const char * getDefaultIconTitle (void) const
virtual const char * getDefaultTitle (void) const
virtual const char * getDefaultWidgetName (void) const
void registerWidget (QWidget *widget)
void removeVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user=NULL)
void setBaseWidget (QWidget *widget)
void setClassName (const char *const name)
virtual void sizeChanged (const SbVec2s &size)
void unregisterWidget (QWidget *widget)

Detailed Description

The SoQtComponent class is the base class for all GUI components.

Components in the SoQt component library all inherit this abstract base class. It provides basic methods for setting and querying about the relationship between the component object and its underlying Qt object(s).

Application programmers should not need to interface any code against this class, unless they want to extend the SoQt library in entirely new directions. For making new viewer components, for instance, other classes further down the inheritance hierarchy would be better suited for subclassing.

Note that the relationship between all SoQtComponent derived classes and Qt widgets is one of "has-A", not "is-A" – i.e. SoQtComponent contains a QWidget*, it doesn't derive from or subclass it.

Constructor & Destructor Documentation

◆ ~SoQtComponent()

SoQtComponent::~SoQtComponent ( )


◆ SoQtComponent()

SoQtComponent::SoQtComponent ( QWidget *const parent = NULL,
const char *const name = NULL,
const SbBool embed = TRUE )

This is a protected constructor, used only by derived classes.

The parent argument is the parent widget of the component. If you don't supply a parent, the main window (the one given to or returned from SoQt::init()) is used (and the embed argument is considered to be FALSE).

The name argument is the name of the component. If you don't supply one, the name will default to something, depending on the inheritance hierarchy.

The embed argument tells whether the component should be embedded in the parent widget or should create its own shell. This flag is only checked if the parent widget argument is specified (not NULL).

If you create a non-embedded component, the component will create its own shell, which will be a top level shell type. If you embed the component, the component will create a form widget type widget inside the parent widget, which you can get the handle of by calling SoQtComponent::getBaseWidget().

Member Function Documentation

◆ addVisibilityChangeCallback()

void SoQtComponent::addVisibilityChangeCallback ( SoQtComponentVisibilityCB *const func,
void *const user = NULL )

Add a callback which will be called whenever the widget component changes visibility status (because of iconification or deiconification, for instance).

See also
removeVisibilityChangeCallback(), isVisible()

◆ afterRealizeHook()

void SoQtComponent::afterRealizeHook ( void )

A function "hook" / callback invoked just after the window for the component has been realized.

Override this if you need specific initialization for your own component or viewer class to happen right after it has been made visible, but remember to call upwards in the inheritance hierarchy:

// [own initialization here]
virtual void afterRealizeHook(void)
Definition SoQtComponent.cpp:913

Reimplemented in SoQtRenderArea, SoQtExaminerViewer, SoQtFlyViewer, and SoQtPlaneViewer.

◆ getBaseWidget()

QWidget * SoQtComponent::getBaseWidget ( void ) const

An SoQtComponent may be composed of any number of widgets in parent-children relationships in a tree structure with any depth. This method will return the root widget in that tree.

See also

◆ getClassName()

const char * SoQtComponent::getClassName ( void ) const

Returns class name of widget.

◆ getComponent()

SoQtComponent * SoQtComponent::getComponent ( QWidget * widget)

Finds and returns the SoQtComponent corresponding to the given QWidget*, if any. If the widget does not seem to belong to any SoQtComponent, NULL will be returned.

◆ getDefaultIconTitle()

const char * SoQtComponent::getDefaultIconTitle ( void ) const

This method returns the default icon title of the component.

It should be overridden by derived non-abstract classes so icons will get proper titles.

Reimplemented in SoQtRenderArea, SoQtExaminerViewer, SoQtFlyViewer, and SoQtPlaneViewer.

◆ getDefaultTitle()

const char * SoQtComponent::getDefaultTitle ( void ) const

This method returns the default window caption string of the component.

It should be overridden by derived non-abstract classes so the window and pop-up menu will get a proper title.

Reimplemented in SoQtRenderArea, SoQtExaminerViewer, SoQtFlyViewer, and SoQtPlaneViewer.

◆ getDefaultWidgetName()

const char * SoQtComponent::getDefaultWidgetName ( void ) const

This method returns the default name of a component widget class.

It should be overridden by derived non-abstract classes for the topmost widget in the component to have a proper name.

Reimplemented in SoQtRenderArea, SoQtExaminerViewer, SoQtFlyViewer, and SoQtPlaneViewer.

◆ getIconTitle()

const char * SoQtComponent::getIconTitle ( void ) const

Returns the title the window has when iconified.

If an icon title has been set, that icon title is returned. If no icon title has been set, the default icon title is returned.

See also
setIconTitle(), isTopLevelShell()

◆ getParentWidget()

QWidget * SoQtComponent::getParentWidget ( void ) const

Returns the widget which is the parent of (i.e. contains) this component's base widget.

See also
getWidget(), baseWidget(), isTopLevelShell()

◆ getShellWidget()

QWidget * SoQtComponent::getShellWidget ( void ) const

This method returns the shell widget of the component, but only if it was created as a top level shell. NULL will be returned for embedded components.

(The top level shell is the desktop window which contains the component.)

To get the top level shell of embedded components, you can use the SoQt::getShellWidget() method.

See also
isTopLevelShell(), getWidget()

◆ getSize()

SbVec2s SoQtComponent::getSize ( void ) const

Returns the component widget size.

The size that is returned is a cached size value, not a value fetched from the GUI system.

See also

◆ getTitle()

const char * SoQtComponent::getTitle ( void ) const

Returns the window title.

If a title has been set, that title will be returned. If no title has been set, the default title is returned.

See also
setTitle(), isTopLevelShell()

◆ getWidget()

QWidget * SoQtComponent::getWidget ( void ) const

Returns a pointer to the component's window system widget.

See also
getShellWidget(), getParentWidget()

◆ getWidgetName()

const char * SoQtComponent::getWidgetName ( void ) const

Returns name of the widget.

◆ hide()

void SoQtComponent::hide ( void )

This will hide the widget.

See also
show(), isVisible()

◆ initClasses()

void SoQtComponent::initClasses ( void )

This function initializes the type system for all the component classes. It is called indirectly for you when you call SoQt::init().

See also
SoQt::init(), SoQtDevice::initClasses()

◆ isFullScreen()

SbBool SoQtComponent::isFullScreen ( void ) const

Returns whether this widget/component is in full screen mode or not.

◆ isTopLevelShell()

SbBool SoQtComponent::isTopLevelShell ( void ) const

Returns TRUE if this component is a top level shell, i.e. it has a window representation on the desktop.

See also

◆ isVisible()

SbBool SoQtComponent::isVisible ( void )

Returns visibility status on the widget. If any parents of this widget or this widget itself is hidden, returns FALSE.

Note that a widget which is just obscured by other windows on the desktop is not hidden in this sense, and TRUE will be returned.

See also
show(), hide()

◆ registerWidget()

void SoQtComponent::registerWidget ( QWidget * widget)

This method should be used by subclasses to register the widgets they set up from the underlying native toolkit, so they can be "reverse" mapped to the owner component.

Subclasses failing to register the widgets they use will cause the SoQtComponent::getComponent() method to fail with those widgets.

See also
unregisterWidget(), getComponent()

◆ removeVisibilityChangeCallback()

void SoQtComponent::removeVisibilityChangeCallback ( SoQtComponentVisibilityCB *const func,
void *const data = NULL )

Remove one of the callbacks from the list of visibility notification callbacks.

See also
addVisibilityChangeCallback(), isVisible()

◆ setBaseWidget()

void SoQtComponent::setBaseWidget ( QWidget * widget)

Set the core widget for this SoQt component. It is important that subclasses get this correct, as the widget set here will be the widget returned from query methods.

See also

◆ setClassName()

void SoQtComponent::setClassName ( const char *const name)

Set class name of component.

See also
getClassName(), componentClassName()

◆ setComponentCursor()

void SoQtComponent::setComponentCursor ( const SoQtCursor & cursor)

Sets the cursor for this component.

Note: not part of the original SGI InventorXt API.

Reimplemented in SoQtFullViewer.

◆ setFullScreen()

SbBool SoQtComponent::setFullScreen ( const SbBool onoff)

Toggle full screen mode for this component, if possible.

Returns FALSE if operation failed. This might happen if the toolkit doesn't support attempts at making the component cover the complete screen or if the component is not a top level window.

◆ setIconTitle()

void SoQtComponent::setIconTitle ( const char *const title)

This method sets the title of the icon representation of the window.

The title will appear on the window icon, if the component manages its own window.

See also
getIconTitle(), setTitle(), isTopLevelShell()

◆ setSize()

void SoQtComponent::setSize ( const SbVec2s size)

Resize the component widget.

The method assumes the caller knows what he is doing.

See also

◆ setTitle()

void SoQtComponent::setTitle ( const char *const title)

Set the window title of this component. The title will appear on the window title bar, if the component manages its own window.

Note that there is one peculiarity to be aware of if you are using the non-commercial version of Qt: only window titles with the substring "Qt" in them are allowed (!), and attempts to set a window title without this substring will simply be ignored.

See also
getTitle(), setIconTitle(), isTopLevelShell()

◆ setWidgetCursor()

void SoQtComponent::setWidgetCursor ( QWidget * w,
const SoQtCursor & cursor )

Set cursor for a native widget in the underlying toolkit.

Note: not part of the original SGI InventorXt API.

◆ setWindowCloseCallback()

void SoQtComponent::setWindowCloseCallback ( SoQtComponentCB *const func,
void *const data = NULL )

Set up a callback function to use when the component gets closed. A component must be a top level shell for this to have any effect.

For top level shells with no close callback set, the window will simply be hidden. The typical action to take in the callback would be to delete the component.

See also

◆ show()

void SoQtComponent::show ( void )

This will show the widget, de-iconifying and raising it if necessary.

See also
hide(), isVisible()

This function must be called by subclasses after the component's widget has been otherwise initialized.

◆ sizeChanged()

void SoQtComponent::sizeChanged ( const SbVec2s & size)

Called internally from within the SoQt library when the widget embedded in a component changes its size, which is usually triggered by end-user interaction.

This method is then invoked to notify the component that the size has changed. It is called from the top and all the way down to the bottom, the size being adjusted to take into account extra decorations having been added at each level in the component class hierarchy.

Reimplemented in SoQtGLWidget, SoQtRenderArea, SoQtFullViewer, and SoQtViewer.

◆ unregisterWidget()

void SoQtComponent::unregisterWidget ( QWidget * widget)

Remove a previously registered native toolkit widget from the widget-to-component mappings used by SoQtComponent::getComponent().

See also

The documentation for this class was generated from the following files: