OpenStructure
Public Member Functions
ToolOptions Class Reference

#include <tool_options.hh>

Inherits QObject.

Public Member Functions

 ToolOptions ()
 
void AddOption (ToolOption *option)
 
void AddOption (const String &group, ToolOption *option)
 
ToolOptionGroup * FindGroupByName (const String &group_name) const
 
ToolOption * GetOption (const String &group_name, const String &key) const
 
ToolOption * GetOption (const String &key) const
 
const ToolOptionGroups & GetGroups () const
 

Detailed Description

tool options

Most tools are configurable. To simplify and standardise the process of providing widgets to configure these tools, these options are defined using an instance of ToolOptions. A widget to modify these options is then automaticallly created when the tool is added to the ToolManager.

Definition at line 40 of file tool_options.hh.

Constructor & Destructor Documentation

◆ ToolOptions()

Member Function Documentation

◆ AddOption() [1/2]

void AddOption ( const String &  group,
ToolOption *  option 
)

Add option to group.

◆ AddOption() [2/2]

void AddOption ( ToolOption *  option)

Add option to default option group.

◆ FindGroupByName()

ToolOptionGroup* FindGroupByName ( const String &  group_name) const

◆ GetGroups()

const ToolOptionGroups& GetGroups ( ) const

◆ GetOption() [1/2]

ToolOption* GetOption ( const String &  group_name,
const String &  key 
) const

◆ GetOption() [2/2]

ToolOption* GetOption ( const String &  key) const

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