Journal::WindowPaths::anonymous_namespace{JournalWindowPaths.cpp} Namespace Reference

Functions
auto	HasName (const wxString &name)
auto	SameName (const wxWindow &window)
template<typename Pred >
wxWindow *	UniqueWindowAmongPeers (const wxWindowList &list, const Pred &pred)
bool	HasUniqueNameAmongPeers (const wxWindow &window, const wxWindowList &list)
wxWindow *	FindByNameAmongPeers (const wxString &name, const wxWindowList &list)
void	PathComponents (const wxWindow &window, wxArrayStringEx &components)

Variables
constexpr auto	PathSeparator = ':'
constexpr auto	EscapeCharacter = '\\'

Function Documentation

FindByNameAmongPeers()

wxWindow * Journal::WindowPaths::anonymous_namespace{JournalWindowPaths.cpp}::FindByNameAmongPeers	(	const wxString &	name,
		const wxWindowList &	list
	)

Definition at line 76 of file JournalWindowPaths.cpp.

{
   return UniqueWindowAmongPeers(list, HasName(name));
}

References HasName(), name, and UniqueWindowAmongPeers().

Referenced by Journal::WindowPaths::FindByPath().

Here is the call graph for this function:

Here is the caller graph for this function:

HasName()

auto Journal::WindowPaths::anonymous_namespace{JournalWindowPaths.cpp}::HasName ( const wxString &  name )

inline

Returns

a predicate, on a pointer to a window, that it has the given name.

Definition at line 33 of file JournalWindowPaths.cpp.

{
   return [name](const wxWindow *pWindow2){
      return pWindow2 &&
      // Ignore wxStaticText windows, which ShuttleGui may assign the same
      // name as the related control.  Those windows are non-interactive so
      // don't interest us for journalling.
      !dynamic_cast<const wxStaticText *>( pWindow2 ) &&
      // Also exclude this special window type defined in Audacity.
      !dynamic_cast<const auStaticText *>( pWindow2 ) &&
      pWindow2->GetName() == name; };
}

References name.

Referenced by FindByNameAmongPeers(), and SameName().

Here is the caller graph for this function:

HasUniqueNameAmongPeers()

bool Journal::WindowPaths::anonymous_namespace{JournalWindowPaths.cpp}::HasUniqueNameAmongPeers	(	const wxWindow &	window,
		const wxWindowList &	list
	)

Returns

whether the window is uniquely named within the given list

Definition at line 70 of file JournalWindowPaths.cpp.

{
   return &window == UniqueWindowAmongPeers(list, SameName(window));
}

References SameName(), and UniqueWindowAmongPeers().

Referenced by PathComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

PathComponents()

void Journal::WindowPaths::anonymous_namespace{JournalWindowPaths.cpp}::PathComponents	(	const wxWindow &	window,
		wxArrayStringEx &	components
	)

Definition at line 85 of file JournalWindowPaths.cpp.

{
   if ( dynamic_cast<const wxTopLevelWindow*>( &window ) ) {
      if ( HasUniqueNameAmongPeers( window, wxTopLevelWindows ) ) {
         components.push_back( window.GetName() );
         return;
      }
   }
   else if ( auto pParent = window.GetParent() ) {
      // Recur
      PathComponents( *pParent, components );
      if ( !components.empty() &&
          HasUniqueNameAmongPeers( window, pParent->GetChildren() ) ) {
         components.push_back( window.GetName() );
         return;
      }
   }
 
   // Failure
   components.clear();
}

References HasUniqueNameAmongPeers(), and PathComponents().

Referenced by Journal::WindowPaths::FindPath(), and PathComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

SameName()

auto Journal::WindowPaths::anonymous_namespace{JournalWindowPaths.cpp}::SameName ( const wxWindow &  window )

inline

Returns

a predicate, on a pointer to a window, that it has the same name as the given window.

Definition at line 49 of file JournalWindowPaths.cpp.

{
   return HasName( window.GetName() );
}

References HasName().

Referenced by HasUniqueNameAmongPeers().

Here is the call graph for this function:

Here is the caller graph for this function:

UniqueWindowAmongPeers()

template<typename Pred >

wxWindow * Journal::WindowPaths::anonymous_namespace{JournalWindowPaths.cpp}::UniqueWindowAmongPeers	(	const wxWindowList &	list,
		const Pred &	pred
	)

Returns

unique window in the list satisfying the predicate, or null

Definition at line 56 of file JournalWindowPaths.cpp.

{
   const auto begin = list.begin(), end = list.end();
   auto iter1 = std::find_if(begin, end, pred);
   if (iter1 == end)
      return nullptr;
   auto next = iter1, iter2 = std::find_if(++next, end, pred);
   if (iter2 != end)
      return nullptr;
   return *iter1;
}

References details::begin(), and details::end().

Referenced by FindByNameAmongPeers(), and HasUniqueNameAmongPeers().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

EscapeCharacter

constexpr auto Journal::WindowPaths::anonymous_namespace{JournalWindowPaths.cpp}::EscapeCharacter = '\\'

constexpr

Definition at line 28 of file JournalWindowPaths.cpp.

PathSeparator

constexpr auto Journal::WindowPaths::anonymous_namespace{JournalWindowPaths.cpp}::PathSeparator = ':'

constexpr

Definition at line 27 of file JournalWindowPaths.cpp.

Referenced by Journal::WindowPaths::FindByPath(), and Journal::WindowPaths::FindPath().