ProjectStatusFieldsRegistry Struct Reference

Registry of status bar fields. More...

#include <ProjectStatus.h>

Static Public Member Functions
static Registry::GroupItem< StatusBarFieldRegistryTraits > &	Registry ()
	Returns the registry. More...
static void	Visit (const StatusBarFieldRegistryVisitor &visitor)
	Visits all fields in the registry in order. More...
static std::size_t	Count (const AudacityProject *project)
	Returns the number of fields in the registry. If project is no null, only visible fields are counted. More...
static StatusBarFieldItem *	Get (const StatusBarField &identifier)
	Returns the field with the given identifier or nullptr if field is not present. More...
static int	GetFieldIndex (const AudacityProject &project, const StatusBarField &identifier)
	Returns the zero based index of the field or -1 if field is not present. More...
static void	OnSize (AudacityProject &project)
	Handle OnSize event for all fields in the registry. More...
static Observer::Subscription	Subscribe (std::function< void(const AudacityProject &, const StatusBarField &)> handler)

Detailed Description

Registry of status bar fields.

Definition at line 82 of file ProjectStatus.h.

Member Function Documentation

Count()

std::size_t ProjectStatusFieldsRegistry::Count ( const AudacityProject *  project )

static

Returns the number of fields in the registry. If project is no null, only visible fields are counted.

Definition at line 214 of file ProjectStatus.cpp.

{
   if (project == nullptr)
      return Registry().size();
 
   auto& group = Registry();
 
   std::size_t count = 0;
   Visit(
      [&](const StatusBarFieldItem& item, const auto&)
      {
         if (item.IsVisible(*project))
            ++count;
      });
 
   return count;
}

References StatusBarFieldItem::IsVisible(), project, Registry(), and Visit().

Referenced by ProjectWindow::CreateProjectStatusBar(), and ProjectWindow::UpdateStatusWidths().

Here is the call graph for this function:

Here is the caller graph for this function:

Get()

StatusBarFieldItem * ProjectStatusFieldsRegistry::Get ( const StatusBarField &  identifier )

static

Returns the field with the given identifier or nullptr if field is not present.

Definition at line 232 of file ProjectStatus.cpp.

{
   StatusBarFieldItem* result = nullptr;
 
   Visit(
      [&](const StatusBarFieldItem& item, const auto&)
      {
         if (item.name == identifier)
            result = const_cast<StatusBarFieldItem*>(&item);
      });
 
   return result;
}

References Registry::detail::BaseItem::name, and Visit().

Referenced by ProjectStatus::Get(), audacity::cloud::audiocom::sync::CloudSyncStatusField::MarkDirty(), and ProjectStatus::Set().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFieldIndex()

int ProjectStatusFieldsRegistry::GetFieldIndex ( const AudacityProject &  project, const StatusBarField &  identifier  )

static

Returns the zero based index of the field or -1 if field is not present.

Definition at line 246 of file ProjectStatus.cpp.

{
   int result = -1;
   int currentIndex = 1;
   Visit(
      [&](const StatusBarFieldItem& item, const auto&)
      {
         if (!item.IsVisible(project))
            return;
 
         if (item.name == identifier)
            result = currentIndex;
         ++currentIndex;
      });
 
   return result;
}

References StatusBarFieldItem::IsVisible(), Registry::detail::BaseItem::name, project, and Visit().

Referenced by audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::OnSize(), and ProjectManager::SetStatusText().

Here is the call graph for this function:

Here is the caller graph for this function:

OnSize()

void ProjectStatusFieldsRegistry::OnSize ( AudacityProject &  project )

static

Handle OnSize event for all fields in the registry.

Definition at line 265 of file ProjectStatus.cpp.

{
   Visit([&](const StatusBarFieldItem& item, const auto&)
         { const_cast<StatusBarFieldItem&>(item).OnSize(project); });
}

References OnSize(), project, and Visit().

Referenced by ProjectWindow::CreateProjectStatusBar(), OnSize(), and ProjectWindow::UpdateStatusWidths().

Here is the call graph for this function:

Here is the caller graph for this function:

Registry()

Registry::GroupItem< StatusBarFieldRegistryTraits > & ProjectStatusFieldsRegistry::Registry ( )

static

Returns the registry.

Definition at line 194 of file ProjectStatus.cpp.

{
   static Registry::GroupItem<StatusBarFieldRegistryTraits> registry {
      PathStart
   };
   return registry;
}

References anonymous_namespace{ProjectStatus.cpp}::PathStart.

Referenced by Count(), and Visit().

Here is the caller graph for this function:

Subscribe()

Observer::Subscription ProjectStatusFieldsRegistry::Subscribe ( std::function< void(const AudacityProject &, const StatusBarField &)>  handler )

static

Definition at line 271 of file ProjectStatus.cpp.

{
   return Dispatcher::Get().Subscribe(std::move(handler));
}

References BasicUI::Get(), and audacity::cloud::audiocom::anonymous_namespace{AuthorizationHandler.cpp}::handler.

Here is the call graph for this function:

Visit()

void ProjectStatusFieldsRegistry::Visit ( const StatusBarFieldRegistryVisitor &  visitor )

static

Visits all fields in the registry in order.

Definition at line 202 of file ProjectStatus.cpp.

{
   static Registry::OrderingPreferenceInitializer init {
      PathStart,
      { { L"", L"state,main,rate" } },
   };
 
   Registry::GroupItem<StatusBarFieldRegistryTraits> top { PathStart };
   Registry::VisitWithFunctions(visitor, &top, &Registry());
}

References anonymous_namespace{ProjectStatus.cpp}::PathStart, Registry(), and Registry::VisitWithFunctions().

Referenced by Count(), ProjectWindow::CreateProjectStatusBar(), Get(), GetFieldIndex(), OnSize(), ProjectStatus::UpdatePrefs(), and ProjectWindow::UpdateStatusWidths().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• ProjectStatus.h
• ProjectStatus.cpp