boinc/clientgui/BOINCBaseView.cpp

// $Id$
//
// The contents of this file are subject to the BOINC Public License
// Version 1.0 (the "License"); you may not use this file except in
// compliance with the License. You may obtain a copy of the License at
// http://boinc.berkeley.edu/license_1.0.txt
// 
// Software distributed under the License is distributed on an "AS IS"
// basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
// License for the specific language governing rights and limitations
// under the License. 
// 
// The Original Code is the Berkeley Open Infrastructure for Network Computing. 
// 
// The Initial Developer of the Original Code is the SETI@home project.
// Portions created by the SETI@home project are Copyright (C) 2002
// University of California at Berkeley. All Rights Reserved. 
// 
// Contributor(s):
//
// Revision History:
//

#if defined(__GNUG__) && !defined(__APPLE__)
#pragma implementation "BOINCBaseView.h"
#endif

#include "stdwx.h"
#include "BOINCGUIApp.h"
#include "MainDocument.h"
#include "BOINCBaseView.h"
#include "BOINCTaskCtrl.h"
#include "BOINCListCtrl.h"

#include "res/boinc.xpm"


const wxString LINK_DEFAULT             = wxT("default");


IMPLEMENT_DYNAMIC_CLASS(CBOINCBaseView, wxPanel)


CBOINCBaseView::CBOINCBaseView()
{
}


CBOINCBaseView::CBOINCBaseView( wxNotebook* pNotebook, wxWindowID iHtmlWindowID, wxInt32 iHtmlWindowFlags, wxWindowID iListWindowID, wxInt32 iListWindowFlags ) :
    wxPanel( pNotebook, -1, wxDefaultPosition, wxDefaultSize, wxTAB_TRAVERSAL )
{
    wxASSERT(NULL != pNotebook);

    m_bProcessingTaskRenderEvent = false;
    m_bProcessingListRenderEvent = false;

    m_bItemSelected = false;

    m_strQuickTip = wxEmptyString;
    m_strQuickTipText = wxEmptyString;

    m_pTaskPane = NULL;
    m_pListPane = NULL;

    wxFlexGridSizer* itemFlexGridSizer = new wxFlexGridSizer(2, 0, 0);
    wxASSERT(NULL != itemFlexGridSizer);

    itemFlexGridSizer->AddGrowableRow(0);
    itemFlexGridSizer->AddGrowableCol(1);
    
    SetSizer(itemFlexGridSizer);
    SetAutoLayout(TRUE);

    m_pTaskPane = new CBOINCTaskCtrl( this, iHtmlWindowID, iHtmlWindowFlags );
    wxASSERT(NULL != m_pTaskPane);

    m_pListPane = new CBOINCListCtrl( this, iListWindowID, iListWindowFlags );
    wxASSERT(NULL != m_pListPane);

    itemFlexGridSizer->Add(m_pTaskPane, 0, wxGROW|wxGROW|wxALL, 1);
    itemFlexGridSizer->Add(m_pListPane, 0, wxGROW|wxGROW|wxALL, 1);
}


CBOINCBaseView::~CBOINCBaseView()
{
}


// The user friendly name of the view.
//   If it has not been defined by the view "Undefined" is returned.
//
wxString CBOINCBaseView::GetViewName()
{
    return wxString(_T("Undefined"));
}


// The user friendly icon of the view.
//   If it has not been defined by the view the BOINC icon is returned.
//
char** CBOINCBaseView::GetViewIcon()
{
    wxASSERT(NULL != boinc_xpm);
    return boinc_xpm;
}


wxInt32 CBOINCBaseView::GetListRowCount()
{
    wxASSERT(NULL != m_pListPane);
    return m_pListPane->GetItemCount();
}


void CBOINCBaseView::FireOnTaskRender ( wxTimerEvent& event )
{
    OnTaskRender( event );
}


void CBOINCBaseView::FireOnListRender ( wxTimerEvent& event )
{
    OnListRender( event );
}


bool CBOINCBaseView::FireOnSaveState( wxConfigBase* pConfig )
{
    return OnSaveState( pConfig );
}


bool CBOINCBaseView::FireOnRestoreState( wxConfigBase* pConfig )
{
    return OnRestoreState( pConfig );
}


void CBOINCBaseView::FireOnChar( wxKeyEvent& event )
{
    OnChar( event );
}


void CBOINCBaseView::FireOnListSelected( wxListEvent& event )
{
    OnListSelected( event );
}


void CBOINCBaseView::FireOnListDeselected( wxListEvent& event )
{
    OnListDeselected( event );
}


wxString CBOINCBaseView::FireOnListGetItemText( long item, long column ) const
{
    return OnListGetItemText( item, column );
}


int CBOINCBaseView::FireOnListGetItemImage( long item ) const
{
    return OnListGetItemImage( item );
}


wxListItemAttr* CBOINCBaseView::FireOnListGetItemAttr( long item ) const
{
    return OnListGetItemAttr( item );
}


void CBOINCBaseView::FireOnTaskLinkClicked( const wxHtmlLinkInfo& link )
{
    OnTaskLinkClicked( link );
}


void CBOINCBaseView::FireOnTaskCellMouseHover( wxHtmlCell* cell, wxCoord x, wxCoord y )
{
    OnTaskCellMouseHover( cell, x, y );
}


wxInt32 CBOINCBaseView::GetDocCount()
{
    return 0;
}


void CBOINCBaseView::OnTaskRender ( wxTimerEvent& event )
{
    if (!m_bProcessingTaskRenderEvent)
    {
        m_bProcessingTaskRenderEvent = true;

        wxASSERT(NULL != m_pListPane);

        if ( ( 0 == m_pListPane->GetSelectedItemCount() ) && m_bItemSelected )
        {
            UpdateSelection();
        }

        m_bProcessingTaskRenderEvent = false;
    }
    else
    {
        event.Skip();
    }
}


void CBOINCBaseView::OnListRender ( wxTimerEvent& event )
{
    if (!m_bProcessingListRenderEvent)
    {
        m_bProcessingListRenderEvent = true;

        wxASSERT(NULL != m_pListPane);

        m_pListPane->Freeze();

        wxInt32 iDocCount = GetDocCount();
        wxInt32 iCacheCount = GetCacheCount();
        if ( iDocCount != iCacheCount )
        {
            if ( 0 >= iDocCount )
            {
                EmptyCache();
                m_pListPane->DeleteAllItems();
            }
            else
            {
                if ( !(iDocCount == iCacheCount) )
                {
                    if ( iDocCount > iCacheCount )
                    {
                        wxInt32 iIndex = 0;
                        wxInt32 iReturnValue = -1;
                        for ( iIndex = iCacheCount; iIndex <= iDocCount; iIndex++ )
                        {
                            iReturnValue = AddCacheElement();
                            wxASSERT( 0 == iReturnValue );
                        }
                    }
                    else
                    {
                        wxInt32 iIndex = 0;
                        wxInt32 iReturnValue = -1;
                        for ( iIndex = iDocCount; iIndex >= iCacheCount; iIndex-- )
                        {
                            iReturnValue = RemoveCacheElement();
                            wxASSERT( 0 == iReturnValue );
                        }
                    }

                    m_pListPane->SetItemCount(iDocCount);
                }
            }
        }

        SyncronizeCache();

        if (EnsureLastItemVisible())
            m_pListPane->EnsureVisible(iCacheCount);

        m_pListPane->Thaw();

        m_bProcessingListRenderEvent = false;
    }

    event.Skip();
}


bool CBOINCBaseView::OnSaveState( wxConfigBase* pConfig )
{
    bool bReturnValue = true;

    wxASSERT(NULL != pConfig);
    wxASSERT(NULL != m_pTaskPane);
    wxASSERT(NULL != m_pListPane);

    if (!m_pTaskPane->OnSaveState( pConfig ))
        bReturnValue = false;

    if (!m_pListPane->OnSaveState( pConfig ))
        bReturnValue = false;

    return bReturnValue;
}


bool CBOINCBaseView::OnRestoreState( wxConfigBase* pConfig )
{
    bool bReturnValue = true;

    wxASSERT(NULL != pConfig);
    wxASSERT(NULL != m_pTaskPane);
    wxASSERT(NULL != m_pListPane);

    if (!m_pTaskPane->OnRestoreState( pConfig ))
        bReturnValue = false;

    if (!m_pListPane->OnRestoreState( pConfig ))
        bReturnValue = false;

    return bReturnValue;
}


void CBOINCBaseView::OnChar( wxKeyEvent& event )
{
    event.Skip();
}


void CBOINCBaseView::OnListSelected( wxListEvent& event )
{
    SetCurrentQuickTip(
        LINK_DEFAULT, 
        wxT("")
    );

    UpdateSelection();
    event.Skip();
}


void CBOINCBaseView::OnListDeselected( wxListEvent& event )
{
    SetCurrentQuickTip(
        LINK_DEFAULT, 
        wxT("")
    );

    UpdateSelection();
    event.Skip();
}


wxString CBOINCBaseView::OnListGetItemText( long WXUNUSED(item), long WXUNUSED(column) ) const
{
    return wxString("Undefined");
}


int CBOINCBaseView::OnListGetItemImage( long WXUNUSED(item) ) const
{
    return -1;
}


wxListItemAttr* CBOINCBaseView::OnListGetItemAttr( long WXUNUSED(item) ) const
{
    return NULL;
}


wxString CBOINCBaseView::OnDocGetItemText( long WXUNUSED(item), long WXUNUSED(column) ) const
{
    return wxString("Undefined");
}


wxString CBOINCBaseView::OnDocGetItemImage( long WXUNUSED(item) ) const
{
    return wxString("Undefined");
}


wxString CBOINCBaseView::OnDocGetItemAttr( long WXUNUSED(item) ) const
{
    return wxString("Undefined");
}


void CBOINCBaseView::OnTaskLinkClicked( const wxHtmlLinkInfo& WXUNUSED(link) )
{
}


void CBOINCBaseView::OnTaskCellMouseHover( wxHtmlCell* WXUNUSED(cell), wxCoord WXUNUSED(x) , wxCoord WXUNUSED(y) )
{
}


wxString CBOINCBaseView::GetCurrentQuickTip()
{
    return m_strQuickTip;
}


wxString CBOINCBaseView::GetCurrentQuickTipText()
{
    return m_strQuickTipText;
}


void CBOINCBaseView::SetCurrentQuickTip( const wxString& strQuickTip, const wxString& strQuickTipText )
{
    m_strQuickTip = strQuickTip;
    m_strQuickTipText = strQuickTipText;
}


wxInt32 CBOINCBaseView::AddCacheElement()
{
    return -1;
}

    
wxInt32 CBOINCBaseView::EmptyCache()
{
    return -1;
}


wxInt32 CBOINCBaseView::GetCacheCount()
{
    return -1;
}


wxInt32 CBOINCBaseView::RemoveCacheElement()
{
    return -1;
}


wxInt32 CBOINCBaseView::SyncronizeCache()
{
    wxInt32         iRowIndex        = 0;
    wxInt32         iRowTotal        = 0;
    wxInt32         iColumnIndex     = 0;
    wxInt32         iColumnTotal     = 0;
    wxString        strDocumentText  = wxEmptyString;
    wxString        strListPaneText  = wxEmptyString;
    wxInt32         iReturnValue     = -1;
    bool            bNeedRefreshData = false;

    iRowTotal = GetDocCount();
    iColumnTotal = m_pListPane->GetColumnCount();

    for ( iRowIndex = 0; iRowIndex < iRowTotal; iRowIndex++ )
    {
        bNeedRefreshData = false;

        for ( iColumnIndex = 0; iColumnIndex < iColumnTotal; iColumnIndex++ )
        {
            strDocumentText.Empty();
            strListPaneText.Empty();

            strDocumentText = OnDocGetItemText( iRowIndex, iColumnIndex );
            strListPaneText = OnListGetItemText( iRowIndex, iColumnIndex );

            if ( !strDocumentText.IsSameAs(strListPaneText) )
            {
                iReturnValue = UpdateCache( iRowIndex, iColumnIndex, strDocumentText );
                wxASSERT( 0 == iReturnValue );
                bNeedRefreshData = true;
            }
        }

        if ( bNeedRefreshData )
        {
            m_pListPane->RefreshItem( iRowIndex );
        }
    }

    return 0;
}


wxInt32 CBOINCBaseView::UpdateCache( long WXUNUSED(item), long WXUNUSED(column), wxString& WXUNUSED(strNewData) )
{
    return -1;
}


bool CBOINCBaseView::EnsureLastItemVisible()
{
    return false;
}


bool CBOINCBaseView::UpdateQuickTip( const wxString& strCurrentLink, const wxString& strQuickTip, const wxString& strQuickTipText )
{
    bool bRetVal;

    bRetVal = false;

    if ( (strCurrentLink == strQuickTip) && (strQuickTip != GetCurrentQuickTip()) )
    {
        SetCurrentQuickTip( strQuickTip, strQuickTipText );
        bRetVal = true;
    }

    return bRetVal;
}


void CBOINCBaseView::UpdateSelection()
{
}


void CBOINCBaseView::UpdateTaskPane()
{
}


#ifdef __GNUC__
static volatile const char  __attribute__((unused)) *BOINCrcsid="$Id$";
#else
static volatile const char *BOINCrcsid="$Id$";
#endif