ExportOption Struct Reference

A type that provides a description of an exporting option. Isn't allowed to change except non-type related flags. More...

#include <ExportTypes.h>

Collaboration diagram for ExportOption:

Public Types
enum	Flags : int {   TypeMask = 0xff , TypeRange = 1 , TypeEnum = 2 , ReadOnly = 0x100 ,   Hidden = 0x200 , Default = 0 }

Public Attributes
ExportOptionID	id
	Internal option id. More...
TranslatableString	title
	Name of an option in a human-readable form. More...
ExportValue	defaultValue
	Default valid value for the parameter. More...
int	flags { Default }
	A set of flag that desc. More...
std::vector< ExportValue >	values {}
	Interpretation depends on type. More...
TranslatableStrings	names {}
	Interpretation depends on type. More...

Detailed Description

A type that provides a description of an exporting option. Isn't allowed to change except non-type related flags.

Definition at line 42 of file ExportTypes.h.

Member Enumeration Documentation

Flags

enum ExportOption::Flags : int

Enumerator
TypeMask	Mask for bits that hold option type.
TypeRange	Range option. values holds [min, max].
TypeEnum	List/enum option. values holds items, and names text to be displayed.
ReadOnly	Parameter is read-only, client should not attempt to change it's value.
Hidden	Option is not used and may be hidden from the user.
Default	No special flags.

Definition at line 44 of file ExportTypes.h.

   {
      TypeMask         = 0xff, 
      TypeRange        = 1,    
      TypeEnum         = 2,    
 
      ReadOnly         = 0x100, 
      Hidden           = 0x200, 
 
      Default          = 0      
   };

Member Data Documentation

defaultValue

ExportValue ExportOption::defaultValue

Default valid value for the parameter.

Definition at line 58 of file ExportTypes.h.

Referenced by anonymous_namespace{ExportOGG.cpp}::ExportOptionOGGEditor::ExportOptionOGGEditor(), and anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFTypedEditor::ExportOptionsSFTypedEditor().

flags

int ExportOption::flags { Default }

A set of flag that desc.

Definition at line 59 of file ExportTypes.h.

Referenced by anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFTypedEditor::ExportOptionsSFTypedEditor(), anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor::Load(), ExportOptionsHandler::OnExportOptionChange(), anonymous_namespace{ExportWavPack.cpp}::ExportOptionsWavPackEditor::OnHybridModeChange(), and ExportOptionsHandler::PopulateOptions().

id

ExportOptionID ExportOption::id

Internal option id.

Definition at line 56 of file ExportTypes.h.

Referenced by anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFTypedEditor::ExportOptionsSFTypedEditor(), ExportOptionsHandler::OnExportOptionChange(), ExportUtils::ParametersFromEditor(), and ExportOptionsHandler::PopulateOptions().

names

TranslatableStrings ExportOption::names {}

Interpretation depends on type.

Definition at line 61 of file ExportTypes.h.

Referenced by anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFTypedEditor::ExportOptionsSFTypedEditor(), and ExportOptionsHandler::PopulateOptions().

title

TranslatableString ExportOption::title

Name of an option in a human-readable form.

Definition at line 57 of file ExportTypes.h.

Referenced by anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFTypedEditor::ExportOptionsSFTypedEditor(), and ExportOptionsHandler::PopulateOptions().

values

std::vector<ExportValue> ExportOption::values {}

Interpretation depends on type.

Definition at line 60 of file ExportTypes.h.

Referenced by anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFTypedEditor::ExportOptionsSFTypedEditor(), ExportOptionsHandler::PopulateOptions(), and anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFTypedEditor::SetValue().

---

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

• ExportTypes.h