QGroundControl
Ground Control Station for MAVLink Drones
Loading...
Searching...
No Matches
ScriptingComponent Class Reference

#include <ScriptingComponent.h>

+ Inheritance diagram for ScriptingComponent:
+ Collaboration diagram for ScriptingComponent:

Public Member Functions

 ScriptingComponent (Vehicle *vehicle, AutoPilotPlugin *autopilot, QObject *parent=nullptr)
 
QStringList setupCompleteChangedTriggerList () const override
 
QString name () const override
 
QString description () const override
 
QString iconResource () const override
 
bool requiresSetup () const override
 
bool setupComplete () const override
 
QUrl setupSource () const override
 
QUrl summaryQmlSource () const override
 
- Public Member Functions inherited from VehicleComponent
 VehicleComponent (Vehicle *vehicle, AutoPilotPlugin *autopilot, AutoPilotPlugin::KnownVehicleComponent KnownVehicleComponent, QObject *parent=nullptr)
 
virtual ~VehicleComponent ()
 
virtual QString vehicleConfigJson () const
 Resource path to a VehicleConfig.json page definition, or empty if none.
 
virtual QStringList sections () const
 
QVariantMap sectionKeywords () const
 Search keywords per section, keyed by section title. Values are original-case translatable terms.
 
virtual bool showFirstSectionOnRootClick () const
 When true, clicking the root component in the tree selects the first section instead of showing all.
 
virtual Q_INVOKABLE bool sectionSetupComplete (const QString &sectionName) const
 Returns setup-complete status for a named section. Default returns true (no per-section tracking).
 
virtual bool allowSetupWhileArmed () const
 
virtual bool allowSetupWhileFlying () const
 
virtual void addSummaryQmlComponent (QQmlContext *context, QQuickItem *parent)
 
virtual void setupTriggerSignals ()
 
AutoPilotPlugin::KnownVehicleComponent KnownVehicleComponent () const
 

Additional Inherited Members

- Signals inherited from VehicleComponent
void setupCompleteChanged ()
 
void setupSourceChanged ()
 
void sectionsChanged ()
 
- Protected Slots inherited from VehicleComponent
void _triggerUpdated (QVariant)
 
- Protected Attributes inherited from VehicleComponent
Vehicle_vehicle = nullptr
 
AutoPilotPlugin_autopilot = nullptr
 
AutoPilotPlugin::KnownVehicleComponent _KnownVehicleComponent
 

Detailed Description

Definition at line 5 of file ScriptingComponent.h.

Constructor & Destructor Documentation

◆ ScriptingComponent()

ScriptingComponent::ScriptingComponent ( Vehicle vehicle,
AutoPilotPlugin autopilot,
QObject *  parent = nullptr 
)
explicit

Definition at line 3 of file ScriptingComponent.cc.

Member Function Documentation

◆ description()

QString ScriptingComponent::description ( void  ) const
inlineoverridevirtual

Reimplemented from VehicleComponent.

Definition at line 14 of file ScriptingComponent.h.

◆ iconResource()

QString ScriptingComponent::iconResource ( void  ) const
inlineoverridevirtual

Implements VehicleComponent.

Definition at line 15 of file ScriptingComponent.h.

◆ name()

QString ScriptingComponent::name ( void  ) const
inlineoverridevirtual

Implements VehicleComponent.

Definition at line 13 of file ScriptingComponent.h.

◆ requiresSetup()

bool ScriptingComponent::requiresSetup ( void  ) const
inlineoverridevirtual

Implements VehicleComponent.

Definition at line 16 of file ScriptingComponent.h.

◆ setupComplete()

bool ScriptingComponent::setupComplete ( void  ) const
inlineoverridevirtual

Implements VehicleComponent.

Definition at line 17 of file ScriptingComponent.h.

◆ setupCompleteChangedTriggerList()

QStringList ScriptingComponent::setupCompleteChangedTriggerList ( ) const
inlineoverridevirtual

Returns an list of parameter names for which a change should cause the setupCompleteChanged signal to be emitted.

Implements VehicleComponent.

Definition at line 12 of file ScriptingComponent.h.

◆ setupSource()

QUrl ScriptingComponent::setupSource ( void  ) const
inlineoverridevirtual

Implements VehicleComponent.

Definition at line 18 of file ScriptingComponent.h.

◆ summaryQmlSource()

QUrl ScriptingComponent::summaryQmlSource ( void  ) const
inlineoverridevirtual

Implements VehicleComponent.

Definition at line 19 of file ScriptingComponent.h.


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