RStudio Launcher Plugin SDK  1.1.3
A software development kit for creating plugins that work the the RStudio Launcher.
Public Member Functions | Static Public Member Functions | List of all members
rstudio::launcher_plugins::quickstart::QuickStartOptions Class Reference

Class which defines options for the QuickStart Launcher Plugin. More...

#include <QuickStartOptions.hpp>

Inheritance diagram for rstudio::launcher_plugins::quickstart::QuickStartOptions:
rstudio::launcher_plugins::Noncopyable

Public Member Functions

bool getSampleOption () const
 Gets the value of the sample option. More...
 
void initialize ()
 Method which initializes QuickStartOptions. This method should be called exactly once, before the options file is read. More...
 
- Public Member Functions inherited from rstudio::launcher_plugins::Noncopyable
 Noncopyable ()=default
 Default constructor.
 
 Noncopyable (const Noncopyable &)=delete
 Deleted copy constructor.
 
Noncopyableoperator= (const Noncopyable &)=delete
 Deleted assignment operator.
 

Static Public Member Functions

static QuickStartOptionsgetInstance ()
 Gets the single instance of QuickStartOptions for the plugin. More...
 

Detailed Description

Class which defines options for the QuickStart Launcher Plugin.

Member Function Documentation

◆ getInstance()

static QuickStartOptions& rstudio::launcher_plugins::quickstart::QuickStartOptions::getInstance ( )
static

Gets the single instance of QuickStartOptions for the plugin.

Returns
The single instance of QuickStartOptions for the plugin.

◆ getSampleOption()

bool rstudio::launcher_plugins::quickstart::QuickStartOptions::getSampleOption ( ) const

Gets the value of the sample option.

Returns
The value of the sample option.

◆ initialize()

void rstudio::launcher_plugins::quickstart::QuickStartOptions::initialize ( )

Method which initializes QuickStartOptions. This method should be called exactly once, before the options file is read.

This is where QuickStart Options are registered with the Options object.


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