Gtk::TreeModelColumnRecord Class Reference

#include <treemodelcolumn.h>

Inherited by ActionManager::ActionModel::Columns, AddRouteDialog::TrackTemplateColumns, AddVideoDialog::HarvidColumns, AnalysisWindow::TrackListColumns, ArdourSurface::C1GUI::MidiPortColumns, ArdourSurface::C1GUI::PluginAssignmentEditorColumns, ArdourSurface::C1GUI::PluginColumns, ArdourSurface::CC121GUI::MidiPortColumns, ArdourSurface::Console1::PluginControllerColumns, ArdourSurface::FP8::FP8GUI::MidiPortColumns, ArdourSurface::FPGUI::MidiPortColumns, ArdourSurface::LCXLGUI::ActionColumns, ArdourSurface::LCXLGUI::MidiPortColumns, ArdourSurface::LPPRO_GUI::MidiPortColumns, ArdourSurface::LP_X::LK4_GUI::MidiPortColumns, ArdourSurface::LP_X::LPX_GUI::MidiPortColumns, ArdourSurface::NS_MCU::MackieControlProtocolGUI::FunctionKeyColumns, ArdourSurface::NS_MCU::MackieControlProtocolGUI::MidiPortColumns, ArdourSurface::P2GUI::MidiPortColumns, ArdourSurface::P2GUI::PressureModeColumns, ArdourSurface::US2400ProtocolGUI::FunctionKeyColumns, ArdourSurface::US2400ProtocolGUI::MidiPortColumns, BundleManager::ModelColumns, ColorThemeManager::ColorAliasModelColumns, ColorThemeManager::ColorThemeModelColumns, EditorRouteGroups::Columns, EditorSections::Columns, EditorSnapshots::Columns, EngineControl::ChannelNameCols, ExportFilenameSelector::DateFormatCols, ExportFilenameSelector::TimeFormatCols, ExportFormatDialog::CodecQualityCols, ExportFormatDialog::CompatibilityCols, ExportFormatDialog::DemoNoiseCols, ExportFormatDialog::DitherTypeCols, ExportFormatDialog::FormatCols, ExportFormatDialog::QualityCols, ExportFormatDialog::SRCQualityCols, ExportFormatDialog::SampleFormatCols, ExportFormatDialog::SampleRateCols, ExportFormatSelector::FormatCols, ExportPresetSelector::PresetCols, ExportTimespanSelector::RangeCols, ExportTimespanSelector::TimeFormatCols, Gtk::ComboBoxEntryText::TextModelColumns, Gtk::ComboBoxText::TextModelColumns, Gtk::ListViewText::TextModelColumns, Gtkmm2ext::StringCompletion::CompletionRecord, InstrumentSelector::InstrumentListColumns, KeyEditor::Tab::KeyEditorColumns, LibraryDownloadDialog::LibraryColumns, LuaScriptManager::LuaActionScriptModelColumns, LuaScriptManager::LuaCallbackScriptModelColumns, LuaScriptManager::LuaSessionScriptModelColumns, MidiListEditor::MidiListModelColumns, MidiListEditor::NoteLengthColumns, MidiTracer::MidiPortCols, Mixer_UI::GroupDisplayModelColumns, Mixer_UI::PluginsDisplayModelColumns, Mixer_UI::StripTemplateModelColumns, Mixer_UI::StripableDisplayModelColumns, OptionEditor::OptionColumns, PlaylistSelector::ModelColumns, PluginEqGui::dBSelectionColumns, PluginManagerUI::PluginColumns, PluginPresetsUI::PluginPresetModelColumns, PluginPresetsUI::TagFilterModelColumns, PluginSelector::AddedColumns, PluginSelector::PluginColumns, PortExportChannelSelector::RouteCols, PortExportChannelSelector::RouteCols::PortCols, RegionLayeringOrderEditor::LayeringOrderColumns, RegionListBase::Columns, RouteListBase::ModelColumns, RouteParams_UI::RouteDisplayModelColumns, SessionDialog::DemoColumns, SessionDialog::RecentSessionModelColumns, SessionDialog::SessionTemplateColumns, SessionMetadataSetImportable::Columns, SimpleExportDialog::ExportRangeCols, SoundFileBrowser::FoundTagColumns, SoundFileBrowser::FreesoundColumns, StripImportDialog::SessionTemplateColumns, StripableTreeModel::Columns, TempoDialog::MidiPortCols, TrackExportChannelSelector::TrackCols, TransformDialog::OperatorCols, TransformDialog::PropertyCols, TransformDialog::SourceCols, TransportMastersWidget::PortColumns, TriggerClipPicker::Columns, and VisibilityGroup::ModelColumns.

Public Member Functions
	TreeModelColumnRecord ()
virtual	~TreeModelColumnRecord ()
void	add (TreeModelColumnBase &column)
unsigned int	size () const
const GType *	types () const

Private Member Functions
	TreeModelColumnRecord (const TreeModelColumnRecord &)
TreeModelColumnRecord &	operator= (const TreeModelColumnRecord &)

Private Attributes
std::vector< GType >	column_types_

Detailed Description

Typedefed as TreeModel::ColumnRecord. Keeps a record of TreeModelColumns.

ColumnRecord objects are used to setup a new instance of a TreeModel (or rather, a new instance of an implementation of the model, such as Gtk::ListStore or Gtk::TreeStore). It is convenient to do that by deriving from TreeModel::ColumnRecord:

class MyModelColumns : public Gtk::TreeModel::ColumnRecord
{
public:
  Gtk::TreeModelColumn<Glib::ustring>                filename;
  Gtk::TreeModelColumn<Glib::ustring>                description;
  Gtk::TreeModelColumn< Glib::RefPtr<Gdk::Pixbuf> >  thumbnail;
 
  MyModelColumns() { add(filename); add(description); add(thumbnail); }
};

Whether or not you derive your own ColumnRecord, you need to add the TreeModelColumns to the ColumnRecord with the add() method.

A ColumnRecord instance, such as an instance of MyModelColumns should then be passed to ListStore::create() or TreeStore::create(). The TreeModelColumns, such as the members filename, description and thumbnail can then be used with Gtk::TreeRow::operator[]() to specify the column you're interested in.

Neither TreeModel::ColumnRecord nor the TreeModelColumns contain any real data – they merely describe what C++ type is stored in which column of a TreeModel, and save you from having to repeat that type information in several places.

Thus TreeModel::ColumnRecord can be made a singleton (as long as you make sure it's instantiated after Gtk::Main), even when creating multiple models from it.

Definition at line 70 of file treemodelcolumn.h.

Constructor & Destructor Documentation

TreeModelColumnRecord() [1/2]

Gtk::TreeModelColumnRecord::TreeModelColumnRecord

(

)

~TreeModelColumnRecord()

virtual Gtk::TreeModelColumnRecord::~TreeModelColumnRecord ( )

virtual

TreeModelColumnRecord() [2/2]

Gtk::TreeModelColumnRecord::TreeModelColumnRecord ( const TreeModelColumnRecord &  )

private

Member Function Documentation

add()

void Gtk::TreeModelColumnRecord::add

(

TreeModelColumnBase &

column

)

Adds a TreeModelColumn to this record. add() not only registers the column, but also assigns a column index to it. Once registered, the TreeModelColumn is final, and you're free to pass it around by value.

operator=()

TreeModelColumnRecord& Gtk::TreeModelColumnRecord::operator= ( const TreeModelColumnRecord &  )

private

size()

unsigned int Gtk::TreeModelColumnRecord::size

(

)

const

types()

const GType* Gtk::TreeModelColumnRecord::types

(

)

const

Member Data Documentation

column_types_

std::vector<GType> Gtk::TreeModelColumnRecord::column_types_

private

Definition at line 87 of file treemodelcolumn.h.

---

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

• treemodelcolumn.h