• ActionType
  • ActionType Class

    Describes an Action for a Device. More...

    Header: #include <ActionType>

    Public Functions

    ActionType(const ActionTypeId & id)
    QString displayName() const
    ActionTypeId id() const
    int index() const
    QString name() const
    ParamTypes paramTypes() const
    void setDisplayName(const QString & displayName)
    void setIndex(const int & index)
    void setName(const QString & name)
    void setParamTypes(const ParamTypes & paramTypes)

    Static Public Members

    QStringList mandatoryTypeProperties()
    QStringList typeProperties()

    Detailed Description

    Describes an Action for a Device.

    ActionTypes are contained in DeviceClass templates returned by DevicePlugins in order to describe the hardware supported by the plugin.

    All Actions must have valid a ActionType in order to be useful.

    See also Action.

    Member Function Documentation

    ActionType::ActionType(const ActionTypeId & id)

    Constructs an ActionType with the given id.

    QString ActionType::displayName() const

    Returns the display name of this ActionType.

    See also setDisplayName().

    ActionTypeId ActionType::id() const

    Returns the id of this ActionType.

    int ActionType::index() const

    Returns the index of this ActionType. The index of an ActionType indicates the order in the DeviceClass. This guarantees that a Device will look always the same (Action order).

    See also setIndex().

    [static] QStringList ActionType::mandatoryTypeProperties()

    Returns a list of mandatory properties a ActionType definition must have.

    QString ActionType::name() const

    Returns the name of this ActionType.

    See also setName().

    ParamTypes ActionType::paramTypes() const

    Returns the parameter description of this ActionType. Actions created from this ActionType must have their parameters matching to this template.

    See also setParamTypes().

    void ActionType::setDisplayName(const QString & displayName)

    Set the displayName for this ActionType. This will be visible to the user.

    See also displayName().

    void ActionType::setIndex(const int & index)

    Set the index of this ActionType.

    See also index().

    void ActionType::setName(const QString & name)

    Set the name for this ActionType.

    See also name().

    void ActionType::setParamTypes(const ParamTypes & paramTypes)

    Set the parameter description of this ActionType. Actions created from this ActionType must have their paramTypes matching to this template.

    See also paramTypes().

    [static] QStringList ActionType::typeProperties()

    Returns a list of all valid properties a ActionType definition can have.