SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Classes | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
smtk::view::Configuration Class Reference

Configure a view, specifying types and attributes, without specifying a UI library. More...

#include <Configuration.h>

Collaboration diagram for smtk::view::Configuration:
[legend]

Classes

class  Component
 Configure one item in a view, which may contain children. More...
 

Public Member Functions

 Configuration (const std::string &myType, const std::string &myName)
 
void copyContents (const Configuration &v)
 Copy the contents of one Configuration into another - this Configuration will be the same as v with the exception of its name and type.
 
const std::string & name () const
 
std::string label () const
 Returns the label to be used in the GUI for the Configuration - if there is none defined the name is returned.
 
const std::string & type () const
 
void setType (const std::string &type)
 
const std::string & iconName () const
 
void setIconName (const std::string &iname)
 
Componentdetails ()
 
const Componentdetails () const
 
bool operator== (const Configuration &other) const
 
void setIncludeIndex (std::size_t index)
 These methods are use primarily by I/O operations. More...
 
std::size_t includeIndex () const
 

Static Public Member Functions

static smtk::view::ConfigurationPtr New (const std::string &myType, const std::string &myName)
 

Protected Attributes

std::string m_name
 
std::string m_type
 
std::string m_iconName
 
Component m_details
 
std::size_t m_includeIndex { 0 }
 

Detailed Description

Configure a view, specifying types and attributes, without specifying a UI library.

Member Function Documentation

◆ setIncludeIndex()

void smtk::view::Configuration::setIncludeIndex ( std::size_t  index)
inline

These methods are use primarily by I/O operations.

The include ID corresponds to the include directory information store in the attribute reosurce and is used when writing out the resource to use include files


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