/*
 * Copyright (c) 1999-2000, Eric Moon.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions, and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */


// TransportView.h
// * PURPOSE
//   UI component (view) providing access to a selected
//   NodeGroup's properties & transport controls.
//
// * HISTORY
//   e.moon             18aug99         Begun.

#ifndef __TransportView_H__
#define __TransportView_H__

#include <list>

#include <View.h>
#include <PopUpMenu.h>

class BButton;
class BInvoker;
class BStringView;
class BTextControl;
class BMenuField;
class BMenu;

#include "cortex_defs.h"
__BEGIN_CORTEX_NAMESPACE

class NodeManager;
class NodeGroup;

class NumericValControl;

class _GroupInfoView;
class TransportWindow;

class TransportView :
        public  BView {
        typedef BView _inherited;

        enum message_t {
                // _value: string
                M_SET_NAME                                      = TransportView_message_base
        };

public:                                                                                 // *** ctors/dtor
        virtual ~TransportView(); //nyi
        
        TransportView(
                NodeManager*                                            nodeManager,
                const char*                                                     name); //nyi
        
public:                                                                                 // *** BView
        virtual void AttachedToWindow();
        virtual void AllAttached();
        virtual void DetachedFromWindow();
        virtual void FrameResized(
                float                                                                           width,
                float                                                                           height);
        virtual void KeyDown(
                const char*                                                     bytes,
                int32                                                                           count);
        virtual void MouseDown(
                BPoint                                                                  where);
                
public:                                                                                 // *** BHandler
        virtual void MessageReceived(
                BMessage*                                                               message); //nyi
                
private:                                                                                // *** BHandler impl.
        void _handleSelectGroup(
                BMessage*                                                               message);
                
protected:                                                                      // *** internal operations

        // select the given group; initialize controls
        // (if 0, gray out all controls)
        void _selectGroup(
                uint32                                                                  groupID);

        void _observeGroup();
        void _releaseGroup();
        
        void _initTimeSources();

protected:                                                                      // *** controls

        void _constructControls(); //nyi
        
        void _disableControls();
        void _enableControls();

        void _updateTransportButtons();
        void _updateTimeSource();
        void _updateRunMode();
        
        // convert a position control's value to bigtime_t
        // [e.moon 11oct99]
        bigtime_t _scalePosition(
                double                                                                  value);
        
        void _populateRunModeMenu(
                BMenu*                                                                  menu);
        void _populateTimeSourceMenu(
                BMenu*                                                                  menu);
                
        // add the given invoker to be retargeted to this
        // view (used for controls whose messages need a bit more
        // processing before being forwarded to the NodeGroup.)
        void _addLocalTarget(
                BInvoker*                                                               invoker);

        void _addGroupTarget(
                BInvoker*                                                               invoker);
                
        void _refreshTransportSettings();
        
        // [e.moon 2dec99]
        void _timeSourceCreated(
                BMessage*                                                               message); //nyi
        void _timeSourceDeleted(
                BMessage*                                                               message); //nyi
                
protected:                                                                      // *** layout

        void _initLayout();
        void _updateLayout();

private:
        friend class _GroupInfoView;
        friend class TransportWindow;

        // logical
        NodeManager*                                                    m_manager;
        NodeGroup*                                                              m_group;

        // controls
        _GroupInfoView*                                         m_infoView;
        BMenuField*                                                             m_runModeView;
        BMenuField*                                                             m_timeSourceView;

        BStringView*                                                    m_fromLabel;
        NumericValControl*                              m_regionStartView;
        BStringView*                                                    m_toLabel;
        NumericValControl*                              m_regionEndView;
        
        BButton*                                                                        m_startButton;
        BButton*                                                                        m_stopButton;
        BButton*                                                                        m_prerollButton;
        
        typedef std::list<BInvoker*>            target_set;
        target_set                                                              m_localTargets;
        target_set                                                              m_groupTargets;
        
        // layout
        class _layout_state;
        _layout_state*                                          m_layout;
};

__END_CORTEX_NAMESPACE
#endif /*__TransportView_H__*/