id-scheme.hpp

Go to the documentation of this file.

/*
  ID-SCHEME.hpp  -  naming and ID scheme definitions for the GUI

  Copyright (C)         Lumiera.org
    2017,               Hermann Vosseler <Ichthyostega@web.de>

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of
  the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/


#ifndef STAGE_ID_SCHEME_H
#define STAGE_ID_SCHEME_H


#include "lib/symbol.hpp"
#include "lib/idi/entry-id.hpp"
#include "stage/interact/view-spec-dsl.hpp"


/* === forward declarations === */
namespace steam {
  namespace asset {
    class Timeline;
    
    namespace meta {
      class ErrorLog;
    }
  }
}

namespace stage {
  namespace timeline {
    class TimelineController;
  }
  namespace widget {
    class ErrorLogDisplay;
  }
  namespace idi {
    
    using lib::Literal;
    using lib::idi::EntryID;
    using interact::UICoord;
    
    
    using ID = lib::idi::BareEntryID const&;
    
    /* === primary component view types === */
    using TimelineView = timeline::TimelineController;
    using ErrorLogView = widget::ErrorLogDisplay;
    
    
    template<>
    struct Descriptor<TimelineView>
      {
        using Model = steam::asset::Timeline;
      };
    
    
    template<>
    struct Descriptor<ErrorLogView>
      {
        using Model = steam::asset::meta::ErrorLog;
        
        //
        // alloc = onePerWindow
        // locate = within(InfoBoxPanel)
      };
    
/*
// Timeline
// add to group of timelines within the timelinePanel

alloc = unlimited
locate = perspective(edit).panel(timeline)
          or panel(timeline)
          or currentWindow().panel(timeline).create()

// Viewer
// here multiple alternatives are conceivable
// - allow only a single view instance in the whole application

alloc = onlyOne
locate = external(beamer)
          or view(viewer)
          or perspective(mediaView).panel(viewer)
          or panel(viewer)
          or firstWindow().panel(viewer).view(viewer).create()

// - allow two viewer panels (the standard layout of editing applications)

alloc = limitPerWindow(2)
locate = perspective(edit).panel(viewer)
          or currentWindow().panel(viewer)
          or panel(viewer)
          or currentWindow().panel(viewer).create()

// (Asset)Bin
// within the dedicated asset panel, add to the appropriate group for the kind of asset

alloc = unlimited
locate = currentWindow().perspective(edit).tab(assetType())
          or perspective(asset).view(asset)
          or tab(assetType())
          or view(asset).tab(assetType()).create()
          or firstWindow().panel(asset).view(asset).create()

// Error-Log
// use the current `InfoBoxPanel` if such exists, fall back to using a single view on the primary window

alloc = limitPerWindow(1)
locate = currentWindow().panel(infobox)
          or view(error)
          or panel(infobox)
          or firstWindow().panel(infobox).view(error).create()

*/    
    
    
  }//namespace stage::idi
} // namespace stage
#endif /*STAGE_ID_SCHEME_H*/