SoQtComponent(3)

📦
version 1.6.2 · 3 versions
, in opensuse-leap 16.0

🌸 NAME 🌸

SoQtComponent — hi bestie, welcome to the SoQtComponent(3) manual page! This class is literally the base class for all GUI components. Periodt. 💅

✨ SYNOPSIS ✨

#include <Inventor/Qt/SoQtComponent.h>
  • Inherits: SoQtObject 🫶
  • Inherited by: SoQtGLWidget 🌈

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const — type ID check, slay ⭐
  • virtual ~SoQtComponent () — destructor moment 💀
  • virtual void show (void) — show time ✨
  • virtual void hide (void) — hide, bestie 🙈
  • virtual void setComponentCursor (const SoQtCursor &cursor) — set that component cursor 🎀
  • SbBool isFullScreen (void) const — fullscreen check, no cap
  • SbBool setFullScreen (const SbBool onoff) — set fullscreen onoff 🔥
  • SbBool isVisible (void) — visibility check 👀
  • SbBool isTopLevelShell (void) const — top-level-shell check 🐚
  • QWidget * getWidget (void) const — get that widget 🫶
  • QWidget * getBaseWidget (void) const — get the base widget 🌸
  • QWidget * getShellWidget (void) const — get the shell widget 🦋
  • QWidget * getParentWidget (void) const — get the parent widget 💜
  • void setSize (const SbVec2s size) — set the size
  • SbVec2s getSize (void) const — get the size
  • void setTitle (const char *const title) — set the title 👑
  • const char * getTitle (void) const — get the title
  • void setIconTitle (const char *const title) — set the icon title 🎀
  • const char * getIconTitle (void) const — get the icon title
  • const char * getWidgetName (void) const — get the widget name
  • const char * getClassName (void) const — get the class name
  • void setWindowCloseCallback (SoQtComponentCB *const func, void *const user=NULL) — set that window-close callback, with user=NULL as the default 🫶

🧚 Public Member Functions inherited from SoQtObject 🧚

  • SbBool isOfType (SoType type) const — type check vibes ✨

🌟 Static Public Member Functions 🌟

  • static void initClass (void) — init the class
  • static SoType getClassTypeId (void) — get the class type ID
  • static void setWidgetCursor (QWidget *w, const SoQtCursor &cursor) — set a widget cursor on w 🎯
  • static SoQtComponent * getComponent (QWidget *widget) — get the component for a widget
  • static void initClasses (void) — init the classes, plural, periodt 💅

🦋 Static Public Member Functions inherited from SoQtObject 🦋

  • static void initClass (void) — init the class
  • static SoType getClassTypeId (void) — get the class type ID
  • static void init (void) — init

🔐 Protected Member Functions 🔐

  • SoQtComponent (QWidget *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE) — protected constructor energy 🧚
  • virtual void afterRealizeHook (void) — the after-realize hook
  • void setClassName (const char *const name) — set the class name
  • void setBaseWidget (QWidget *widget) — set the base widget
  • void registerWidget (QWidget *widget) — register a widget
  • void unregisterWidget (QWidget *widget) — unregister a widget
  • virtual const char * getDefaultWidgetName (void) const — get the default widget name
  • virtual const char * getDefaultTitle (void) const — get the default title
  • virtual const char * getDefaultIconTitle (void) const — get the default icon title
  • virtual void sizeChanged (const SbVec2s &size) — size-changed hook
  • void addVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user=NULL) — add a visibility-change callback, with user=NULL default 👀
  • void removeVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user=NULL) — remove a visibility-change callback, same user=NULL default 🙈

💖 Detailed Description 💖

Okay so SoQtComponent is literally the base class for all GUI components. No cap.

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 lowkey 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. Periodt. 💅

Big vibe check: 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. That's the whole mood. 🌈

🎀 Constructor & Destructor Documentation 🎀

💀 SoQtComponent::~SoQtComponent () [virtual] 💀

Destructor. That's it — it's the destructor. 💀

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

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 — and you can get the handle of that by calling SoQtComponent::getBaseWidget(). 💅

💅 Member Function Documentation 💅

okay bestie, this is the function-by-function tea ☕ — every single member function, no skips, no cap. Let's get into it 💖

  • virtual SoType SoQtComponent::getTypeId (void ) const [virtual] — returns the type identification of an object derived from a class inheriting from SoQtObject. This is used for runtime type checking and "downward" casting. Implements SoQtObject.

Usage example:

void foo(SoQtViewer * comp)
{
  if (comp->getTypeId() == SoQtExaminerViewer::getClassTypeId()) {
    // safe downward cast, knows the type
    SoQtExaminerViewer * exviewer = (SoQtExaminerViewer *)comp;
  }
  else if (comp->getTypeId().isOfType(SoQtFlyViewer::getClassTypeId())) {
    // safe downward cast, knows the type
    SoQtFlyViewer * flyviewer = (SoQtFlyViewer *)comp;
    // then something else
  }
}
  • void SoQtComponent::show (void ) [virtual] — 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. no cap, it's important.
  • void SoQtComponent::hide (void ) [virtual] — this will hide the widget. See also: show(), isVisible().
  • void SoQtComponent::setComponentCursor (const SoQtCursor & cursor) [virtual] — sets the cursor for this component.
note: not part of the original SGI InventorXt API.

Reimplemented in SoQtFullViewer.

  • void SoQtComponent::setWidgetCursor (QWidget * w, const SoQtCursor & cursor) [static] — set cursor for a native widget in the underlying toolkit.
note: not part of the original SGI InventorXt API.
  • SbBool SoQtComponent::isFullScreen (void ) const — returns whether this widget/component is in full screen mode or not.
  • 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.
  • 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().
  • 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: getShellWidget().
  • QWidget * SoQtComponent::getWidget (void ) const — returns a pointer to the component's window system widget. See also: getShellWidget(), getParentWidget().
  • 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: setBaseWidget().
  • 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().
  • 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().
  • void SoQtComponent::setSize (const SbVec2s size) — resize the component widget. The method assumes the caller knows what he is doing. See also: 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: setSize().
  • 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().

  • 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().
  • 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().
  • 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().
  • const char * SoQtComponent::getWidgetName (void ) const — returns name of the widget.
  • const char * SoQtComponent::getClassName (void ) const — returns class name of widget.
  • 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: isTopLevelShell().
  • SoQtComponent * SoQtComponent::getComponent (QWidget * widget) [static] — 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.
  • void SoQtComponent::initClasses (void ) [static] — 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().
  • void SoQtComponent::afterRealizeHook (void ) [protected], [virtual] — 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:
void
MyLittleViewer::afterRealizeHook(void)
{
  <superclass>::afterRealizeHook();
  // [own initialization here]
}

Reimplemented in SoQtExaminerViewer, SoQtFlyViewer, SoQtPlaneViewer, and SoQtRenderArea.

  • void SoQtComponent::setClassName (const char *const name) [protected] — set class name of component. See also: getClassName(), componentClassName().
  • void SoQtComponent::setBaseWidget (QWidget * widget) [protected] — 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: baseWidget().
  • void SoQtComponent::registerWidget (QWidget * widget) [protected] — 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().
  • void SoQtComponent::unregisterWidget (QWidget * widget) [protected] — remove a previously registered native toolkit widget from the widget-to-component mappings used by SoQtComponent::getComponent(). See also: registerWidget().
  • const char * SoQtComponent::getDefaultWidgetName (void ) const [protected], [virtual] — 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 SoQtExaminerViewer, SoQtFlyViewer, SoQtPlaneViewer, and SoQtRenderArea.
  • const char * SoQtComponent::getDefaultTitle (void ) const [protected], [virtual] — 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 SoQtExaminerViewer, SoQtFlyViewer, SoQtPlaneViewer, and SoQtRenderArea.
  • const char * SoQtComponent::getDefaultIconTitle (void ) const [protected], [virtual] — 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 SoQtExaminerViewer, SoQtFlyViewer, SoQtPlaneViewer, and SoQtRenderArea.
  • void SoQtComponent::sizeChanged (const SbVec2s & size) [protected], [virtual] — 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 SoQtFullViewer, SoQtGLWidget, SoQtRenderArea, and SoQtViewer.
  • void SoQtComponent::addVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user = NULL) [protected] — 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().
  • void SoQtComponent::removeVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const data = NULL) [protected] — remove one of the callbacks from the list of visibility notification callbacks. See also: addVisibilityChangeCallback(), isVisible().

👑 Author 👑

Generated automatically by Doxygen for SoQt from the source code.

And that's the whole page, bestie! This icon is from SoQt 1.6.2, dated Sat Jan 6 2024 12:20:55, and it's the SoQtComponent(3) page — periodt 💅✨

📦 where this page comes from