audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem Class Reference

Inheritance diagram for audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem:

Collaboration diagram for audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem:

Public Member Functions
	CloudSyncStatusBarFieldItem ()
int	GetDefaultWidth (const AudacityProject &project) const override
void	OnSize (AudacityProject &project) override
void	SetText (AudacityProject &project, const TranslatableString &msg) override
	Sets the current text of the field. More...
TranslatableString	GetText (const AudacityProject &project) const override
	Retrieves the current text of the field. More...
bool	IsVisible (const AudacityProject &project) const override
	Returns true if the field is visible in the status bar of the given project. More...
void	MarkDirty (const AudacityProject &project)
Public Member Functions inherited from StatusBarFieldItem
	StatusBarFieldItem (StatusBarField identifier)
virtual	~StatusBarFieldItem ()
virtual int	GetDefaultWidth (const AudacityProject &project) const =0
virtual void	OnSize (AudacityProject &project)
virtual void	SetText (AudacityProject &project, const TranslatableString &msg)=0
	Sets the current text of the field. More...
virtual TranslatableString	GetText (const AudacityProject &project) const =0
	Retrieves the current text of the field. More...
virtual bool	IsVisible (const AudacityProject &project) const =0
	Returns true if the field is visible in the status bar of the given project. More...
Public Member Functions inherited from Registry::SingleItem
	~SingleItem () override=0
Public Member Functions inherited from Registry::detail::BaseItem
	BaseItem (const Identifier &internalName)
virtual	~BaseItem ()

Additional Inherited Members
Public Attributes inherited from Registry::detail::BaseItem
const Identifier	name
OrderingHint	orderingHint
Protected Member Functions inherited from StatusBarFieldItem
void	DispatchFieldChanged (const AudacityProject &project)
	Derived classes should call this method to notify the status bar that the field has changed. More...

Detailed Description

Definition at line 47 of file CloudSyncStatusField.cpp.

Constructor & Destructor Documentation

CloudSyncStatusBarFieldItem()

audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::CloudSyncStatusBarFieldItem ( )

inline

Definition at line 50 of file CloudSyncStatusField.cpp.

       : StatusBarFieldItem { FieldId }
   {
   }

Member Function Documentation

GetDefaultWidth()

int audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::GetDefaultWidth ( const AudacityProject &  project ) const

inlineoverridevirtual

Return the default width of the field in pixels. This is used to determine the initial width of the field in the status bar. The value may be overridden using StatusWidthFunctions. Returning -1 means that the field is expandable.In this case StatusWidthFunctions have no effect.

Implements StatusBarFieldItem.

Definition at line 55 of file CloudSyncStatusField.cpp.

   {
      return CloudSyncStatusField::Get(project).GetWidth();
   }

References audacity::cloud::audiocom::sync::CloudSyncStatusField::Get(), audacity::cloud::audiocom::sync::CloudSyncStatusField::GetWidth(), and project.

Here is the call graph for this function:

GetText()

TranslatableString audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::GetText ( const AudacityProject &  project ) const

inlineoverridevirtual

Retrieves the current text of the field.

Implements StatusBarFieldItem.

Definition at line 78 of file CloudSyncStatusField.cpp.

   {
      return CloudSyncStatusField::Get(project).GetText();
   }

References audacity::cloud::audiocom::sync::CloudSyncStatusField::Get(), audacity::cloud::audiocom::sync::CloudSyncStatusField::GetText(), and project.

Here is the call graph for this function:

IsVisible()

bool audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::IsVisible ( const AudacityProject &  project ) const

inlineoverridevirtual

Returns true if the field is visible in the status bar of the given project.

Implements StatusBarFieldItem.

Definition at line 83 of file CloudSyncStatusField.cpp.

   {
      return CloudSyncStatusField::Get(project).IsVisible();
   }

References audacity::cloud::audiocom::sync::CloudSyncStatusField::Get(), audacity::cloud::audiocom::sync::CloudSyncStatusField::IsVisible(), and project.

Here is the call graph for this function:

MarkDirty()

void audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::MarkDirty ( const AudacityProject &  project )

inline

Definition at line 88 of file CloudSyncStatusField.cpp.

   {
      DispatchFieldChanged(project);
   }

References project.

OnSize()

void audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::OnSize ( AudacityProject &  project )

inlineoverridevirtual

Called when the status bar associated with the project is resized. Could be used to update the position of the custom status bar field. Default implementation does nothing.

Parameters

project

The project whose status bar has been resized. The reference is non constant, as the field is likely implemented as a client site.

Reimplemented from StatusBarFieldItem.

Definition at line 60 of file CloudSyncStatusField.cpp.

   {
      const auto index =
         ProjectStatusFieldsRegistry::GetFieldIndex(project, name);
 
      if (index < 0)
         return;
 
      wxRect rect;
      if (ProjectWindow::Get(project).GetStatusBar()->GetFieldRect(index, rect))
         CloudSyncStatusField::Get(project).OnSize(rect);
   }

References audacity::cloud::audiocom::sync::CloudSyncStatusField::Get(), ProjectWindow::Get(), ProjectStatusFieldsRegistry::GetFieldIndex(), name, audacity::cloud::audiocom::sync::CloudSyncStatusField::OnSize(), and project.

Here is the call graph for this function:

SetText()

void audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::SetText ( AudacityProject &  project, const TranslatableString &  msg  )

inlineoverridevirtual

Sets the current text of the field.

Implements StatusBarFieldItem.

Definition at line 74 of file CloudSyncStatusField.cpp.

   {
   }

---

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

• CloudSyncStatusField.cpp