3ds Max C++ API Reference
QmaxToolClips Class Reference

The QmaxToolClips class provides a collection of tool clip related methods. More...

#include <QmaxToolClips.h>

Static Public Member Functions

static void disableToolClip (QObject *obj, bool disable=true)
 Disables the tool clip feature on the specified ui object. More...
 
static bool isToolClipDisabled (QObject *obj)
 Retrieves if for a given ui object the tool clip feature is disabled. More...
 

Detailed Description

The QmaxToolClips class provides a collection of tool clip related methods.

The new tool clips replace the common Win32 / Qt tooltips and provide richer, contextual information in a highly graphic fashion. The tool clips are multi-staged, interactive and can offer animated contextual help. On level 1 the tool clips show just a title and shortcut information. Level 2 additionally offers a description text and a video or image. Level 3 can show up an extended description text and a resource list which can contain links to help content like videos, images and web pages. The content for the tool clips is provided by xml control files, where a key that identifies a content block must match with the tool clip key that a ui control provides when the mouse hovers over it.

Member Function Documentation

◆ disableToolClip()

static void disableToolClip ( QObject *  obj,
bool  disable = true 
)
static

Disables the tool clip feature on the specified ui object.

Parameters
objThe ui component on which the tool clip should be disabled / enabled.
disableTrue if the tool clip should be disabled on the given ui component, false otherwise.

◆ isToolClipDisabled()

static bool isToolClipDisabled ( QObject *  obj)
static

Retrieves if for a given ui object the tool clip feature is disabled.

Parameters
objThe ui component for which the tool clip disabled state should be queried.
Returns
true if the tool clip is disabled for the given object, otherwise false.