ToolBarConfiguration::Iterator Class Reference

#include <ToolDock.h>

Inheritance diagram for ToolBarConfiguration::Iterator:

Collaboration diagram for ToolBarConfiguration::Iterator:

Classes
struct	Triple

Public Member Functions
const Place &	operator* () const
const Place *	operator-> () const
Iterator &	operator++ ()
std::vector< int >	GetPath () const

Private Types
using	FIter = Forest::iterator

Private Member Functions
	Iterator ()
	Iterator (ToolBarConfiguration &conf)

Private Attributes
friend	ToolBarConfiguration
Place	mPlace
std::vector< Triple >	mIters

Friends
bool	operator== (const Iterator &lhs, const Iterator &rhs)
bool	operator!= (const Iterator &lhs, const Iterator &rhs)

Additional Inherited Members
Public Types inherited from ValueIterator< Place >
using	iterator_category = std::forward_iterator_tag
using	value_type = Place
using	difference_type = ptrdiff_t
using	pointer = void
using	reference = const Place

Detailed Description

Definition at line 116 of file ToolDock.h.

Member Typedef Documentation

FIter

using ToolBarConfiguration::Iterator::FIter = Forest::iterator

private

Definition at line 208 of file ToolDock.h.

Constructor & Destructor Documentation

Iterator() [1/2]

ToolBarConfiguration::Iterator::Iterator ( )

inlineprivate

Definition at line 195 of file ToolDock.h.

{}

Iterator() [2/2]

ToolBarConfiguration::Iterator::Iterator ( ToolBarConfiguration &  conf )

inlineexplicitprivate

Definition at line 196 of file ToolDock.h.

      {
         auto &forest = conf.mForest;
         if (!forest.empty()) {
            auto b = forest.begin();
            mIters.push_back( Triple { b, b, forest.end() } );
            mPlace.pTree = &*b;
         }
      }

References ToolBarConfiguration::Iterator::Triple::end, ToolBarConfiguration::mForest, mIters, mPlace, and ToolBarConfiguration::Place::pTree.

Member Function Documentation

GetPath()

std::vector< int > ToolBarConfiguration::Iterator::GetPath ( ) const

inline

Definition at line 169 of file ToolDock.h.

      {
         std::vector<int> path;
         path.reserve(mIters.size());
         for (const auto &triple : mIters)
            path.push_back(triple.current - triple.begin);
         return path;
      }

References mIters.

Referenced by ToolBarConfiguration::Write().

Here is the caller graph for this function:

operator*()

const Place & ToolBarConfiguration::Iterator::operator* ( ) const

inline

Definition at line 120 of file ToolDock.h.

{ return mPlace; }

References mPlace.

operator++()

Iterator & ToolBarConfiguration::Iterator::operator++ ( )

inline

Definition at line 122 of file ToolDock.h.

      {
         // This is a feature:  advance position even at the end
         mPlace.position =
            Position{ mPlace.pTree ? mPlace.pTree->pBar : nullptr };
 
         if (!mIters.empty())
         {
            auto triple = &mIters.back();
            auto &children = triple->current->children;
            if (children.empty()) {
               while (++triple->current == triple->end) {
                  mIters.pop_back();
                  if (mIters.empty())
                     break;
                  triple = &mIters.back();
               }
            }
            else {
               auto b = children.begin();
               mIters.push_back( Triple { b, b, children.end() } );
            }
         }
 
         if (mIters.empty()) {
            mPlace.pTree = nullptr;
            // Leave mPlace.position as above
         }
         else {
            const auto &triple = mIters.back();
            mPlace.pTree = &*triple.current;
 
            if (mIters.size() == 1)
               mPlace.position.rightOf = nullptr;
            else
               mPlace.position.rightOf = (mIters.rbegin() + 1)->current->pBar;
 
            if (triple.begin == triple.current)
               mPlace.position.below = nullptr;
            else
               mPlace.position.below = (triple.current - 1)->pBar;
         }
 
         return *this;
      }

References ToolBarConfiguration::Position::below, ToolBarConfiguration::Iterator::Triple::end, mIters, mPlace, ToolBarConfiguration::Tree::pBar, ToolBarConfiguration::Place::position, ToolBarConfiguration::Place::pTree, and ToolBarConfiguration::Position::rightOf.

operator->()

const Place * ToolBarConfiguration::Iterator::operator-> ( ) const

inline

Definition at line 121 of file ToolDock.h.

{ return &**this; }

Friends And Related Function Documentation

operator!=

bool operator!= ( const Iterator &  lhs, const Iterator &  rhs  )

friend

Definition at line 187 of file ToolDock.h.

      {
         return !(lhs == rhs);
      }

operator==

bool operator== ( const Iterator &  lhs, const Iterator &  rhs  )

friend

Definition at line 178 of file ToolDock.h.

      {
         const auto &li = lhs.mIters;
         const auto &ri = rhs.mIters;
         return li.size() == ri.size() &&
            std::equal(li.begin(), li.end(), ri.begin());
      }

Member Data Documentation

mIters

std::vector<Triple> ToolBarConfiguration::Iterator::mIters

private

Definition at line 226 of file ToolDock.h.

Referenced by GetPath(), Iterator(), and operator++().

mPlace

Place ToolBarConfiguration::Iterator::mPlace

private

Definition at line 206 of file ToolDock.h.

Referenced by Iterator(), operator*(), and operator++().

ToolBarConfiguration

friend ToolBarConfiguration::Iterator::ToolBarConfiguration

private

Definition at line 194 of file ToolDock.h.

---

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

• ToolDock.h