mitk::Forms::ParagraphQuestion Class Reference

A Question whose possible response is multi-line free text. More...

#include <mitkParagraphQuestion.h>

Inheritance diagram for mitk::Forms::ParagraphQuestion:

Collaboration diagram for mitk::Forms::ParagraphQuestion:

Public Member Functions
	~ParagraphQuestion () override
	Virtual destructor. More...
std::string	GetType () const override
	Return the type string "Paragraph". More...
Question *	CreateAnother () const override
	Create a new default-constructed ParagraphQuestion instance. More...
void	FromJSON (const nlohmann::ordered_json &j) override
	Deserialize this ParagraphQuestion from JSON. More...
void	ToJSON (nlohmann::ordered_json &j) const override
	Serialize this ParagraphQuestion to JSON. More...
Public Member Functions inherited from mitk::Forms::TextQuestion
	~TextQuestion () override
	Virtual destructor. More...
std::vector< std::string >	GetResponsesAsStrings () const override
	Return the text response as a single-element vector. More...
void	ClearResponses () override
	Clear the text response. More...
bool	IsComplete () const override
	Check whether the response is non-empty. More...
std::string	GetResponse () const
	Get the current text response. More...
void	SetResponse (const std::string &response)
	Set the text response. More...
Public Member Functions inherited from mitk::Forms::Question
	Question ()
	Default constructor. More...
virtual	~Question ()
	Virtual destructor. More...
std::string	GetQuestionText () const
	Get the literal question text. More...
void	SetQuestionText (const std::string &question)
	Set the literal question text. More...
bool	IsRequired () const
	Check whether a response to this question is required to complete a form. More...
void	SetRequired (bool required=true)
	Set whether a response to this question is required to complete a form. More...
virtual std::string	GetRequiredText () const
	Get the text that should be displayed to clearly mark a question as required. More...
virtual bool	HasFileResponses () const
	Query whether the responses given to this question are file paths. More...
virtual std::vector< fs::path >	SubmitFileResponses (const fs::path &basePath) const
	Attach response files to submission. More...

Detailed Description

A Question whose possible response is multi-line free text.

ParagraphQuestion is intended for longer text answers. For single-line short text, use ShortAnswerQuestion instead.

See also

ShortAnswerQuestion, TextQuestion

Definition at line 27 of file mitkParagraphQuestion.h.

Constructor & Destructor Documentation

~ParagraphQuestion()

mitk::Forms::ParagraphQuestion::~ParagraphQuestion ( )

override

Virtual destructor.

Member Function Documentation

CreateAnother()

Question* mitk::Forms::ParagraphQuestion::CreateAnother ( ) const

overridevirtual

Create a new default-constructed ParagraphQuestion instance.

Returns

A pointer to a new ParagraphQuestion. The caller takes ownership.

Implements mitk::Forms::Question.

FromJSON()

void mitk::Forms::ParagraphQuestion::FromJSON ( const nlohmann::ordered_json &  j )

overridevirtual

Deserialize this ParagraphQuestion from JSON.

Parameters

[in]

j

The JSON object to deserialize from.

Implements mitk::Forms::Question.

GetType()

std::string mitk::Forms::ParagraphQuestion::GetType ( ) const

overridevirtual

Return the type string "Paragraph".

Returns

The string "Paragraph".

Implements mitk::Forms::Question.

ToJSON()

void mitk::Forms::ParagraphQuestion::ToJSON ( nlohmann::ordered_json &  j ) const

overridevirtual

Serialize this ParagraphQuestion to JSON.

Parameters

[out]

j

The JSON object to serialize into.

Implements mitk::Forms::Question.

---

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

• mitkParagraphQuestion.h