NCPad.h

/*
  Copyright (C) 2000-2012 Novell, Inc
  This library is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) version 3.0 of the License. This library
  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 Lesser General Public
  License for more details. You should have received a copy of the GNU
  Lesser General Public License along with this library; if not, write
  to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  Floor, Boston, MA 02110-1301 USA
*/


/*-/

   File:       NCPad.h

   Author:     Michael Andres <ma@suse.de>

/-*/

#ifndef NCPad_h
#define NCPad_h

#include <iosfwd>

#include "NCurses.h"
#include "NCWidget.h"


class NCSchrollCB
{
public:

    virtual ~NCSchrollCB() {}

    virtual void HScroll( unsigned total, unsigned visible, unsigned start ) {}

    virtual void VScroll( unsigned total, unsigned visible, unsigned start ) {}

    virtual void ScrollHead( NCursesWindow & w, unsigned ccol ) {}

    virtual void AdjustPadSize( wsze & minsze ) {}
};

class NCScrollHint : protected NCSchrollCB
{
private:

    NCSchrollCB * redirect;

protected:

    NCScrollHint() : redirect( this ) {}

    virtual ~NCScrollHint() {}

protected:

    virtual void SetHead( NCursesWindow & w, unsigned ccol )
    {
    redirect->ScrollHead( w, ccol );
    }

    void VSet( unsigned total, unsigned visible, unsigned start )
    {
    redirect->VScroll( total, visible, start );
    }

    void HSet( unsigned total, unsigned visible, unsigned start )
    {
    redirect->HScroll( total, visible, start );
    }

    virtual void SetPadSize( wsze & minsze )
    {
    redirect->AdjustPadSize( minsze );
    }

public:

    void SendSchrollCB( NCSchrollCB * dest ) { redirect = ( dest ? dest : this ); }

    virtual void SendHead() {}
};


class NCPad : public NCursesPad, public NCScrollHint
{
private:

    int   _vheight;

protected:

    const NCWidget & parw;

    NCursesWindow * destwin; 
    wrect drect;
    wrect srect;        
    wpos  maxdpos;
    wpos  maxspos;

    bool  dclear; 
    bool  dirty;

    int vheight() const        { return _vheight ? _vheight : height(); }

    bool paging() const { return _vheight; }

    virtual int dirtyPad() { dirty = false; return setpos( CurPos() ); }

    virtual int setpos( const wpos & newpos );

    int adjpos( const wpos & offset )
    {
    return setpos( CurPos() + offset );
    }

    virtual void updateScrollHint();

    virtual void directDraw( NCursesWindow & w, const wrect at, unsigned lineno ) {}

public:

    NCPad( int lines, int cols, const NCWidget & p );
    virtual ~NCPad() {}

public:

    NCursesWindow * Destwin() { return destwin; }

    virtual void Destwin( NCursesWindow * dwin );

    virtual void resize( wsze nsze );
    // OMFG this little overload does something completely different than
    // the one above
    virtual int resize( int lines, int columns ) { return NCursesWindow::resize(lines, columns );}
    virtual void wRecoded();
    virtual void setDirty() { dirty = true; }

    int update();
    virtual int setpos() { return setpos( CurPos() ); }

    virtual wpos CurPos() const { return srect.Pos; }

    int ScrlTo( const wpos & newpos )
    {
    return setpos( newpos );
    }

    int ScrlLine( int line )
    {
    return setpos( wpos( line, srect.Pos.C ) );
    }

    int ScrlCol( int col )
    {
    return setpos( wpos( srect.Pos.L, col ) );
    }

    int ScrlDown( int lines = 1 )
    {
    return adjpos( wpos( lines, 0 ) );
    }

    int ScrlUp( int lines = 1 )
    {
    return adjpos( wpos( -lines, 0 ) );
    }

    int ScrlRight( int cols = 1 )
    {
    return adjpos( wpos( 0, cols ) );
    }

    int ScrlLeft( int cols = 1 )
    {
    return adjpos( wpos( 0, -cols ) );
    }

    int ScrlToLastLine()
    {
        return ScrlDown( vheight() );
    }

    virtual bool handleInput( wint_t key );
};


#endif // NCPad_h