Open Search
    SubMenuEntry Class Reference

    #include <datadescription_ui.h>

    Detailed Description

    Structure to store a menu definition.

    Public Member Functions

    Result< void > CopyFrom (const SubMenuEntry &src)
     

    Static Public Member Functions

    static Bool LessThan (const SubMenuEntry &a, const SubMenuEntry &b)
     

    Public Attributes

    Id _identifier
     
    Id _identifierOriginal
     
    String _name
     
    Id _commandShortcutId
     
    Id _iconId
     
    Id _commandId
     
    DESCRIPTIONMESSAGECHECKFLAGS _flags
     
    Id _commandContext
     
    DescriptionMessageCall _function
     
    StrongRef< BaseArray< SubMenuEntry > > _subEntryRef
     

    Member Function Documentation

    ◆ LessThan()

    static Bool LessThan ( const SubMenuEntry a,
    const SubMenuEntry b 
    )
    static

    Compare function for menu sorting.

    Parameters
    [in]aEntry 1.
    [in]bEntry 2.
    Returns
    True if less than on success.

    ◆ CopyFrom()

    Result<void> CopyFrom ( const SubMenuEntry src)

    Member Data Documentation

    ◆ _identifier

    Id _identifier

    unique identifier to allow selections (e.g. in treeviews)

    ◆ _identifierOriginal

    Id _identifierOriginal

    unique identifier to allow feature highilghting

    ◆ _name

    String _name

    name of the menu entry

    ◆ _commandShortcutId

    Id _commandShortcutId

    id of the icon

    ◆ _iconId

    Id _iconId

    id of the icon

    ◆ _commandId

    Id _commandId

    id of the associated C4D command

    ◆ _flags

    state flags of the menu entry see DESCRIPTIONMESSAGECHECKFLAGS.

    ◆ _commandContext

    Id _commandContext

    context to which the command belongs.

    ◆ _function

    function callback to call the function

    ◆ _subEntryRef

    StrongRef<BaseArray<SubMenuEntry> > _subEntryRef

    optional sub menu entry. in that case _function must be nullptr.