|| || || || || || || ||

---

DocScroller.h

Go to the documentation of this file.

//345678901234567890123456789012345678901234567890123456789012345678901234567890
// DocScroller.h
// Unlike ScrollWnd, that automatically scrolls a client window based
// on its size and position, DocScroller does not reposition its client,
// but scrolls the content of its client if it confirms to the
// DocDimensions.h interface.
//
// Author: Richard van Balen
#ifndef OglGui_DocScroller_h
#define OglGui_DocScroller_h

#ifndef OglGui_ScrollWnd_h
#include "OglGui/ScrollWnd.h"
#endif

#ifndef OglGui_DocDimensions_h
#include "OglGui/DocDimensions.h"
#endif

namespace OglGui
{

class DocScroller : public ScrollWnd
{
public:
    DocScroller(int x, int y, int w, int h,int sB=3+12) :
        ScrollWnd(x, y, w, h, true, (sB&1)?1:0, (sB&2)?1:0)
    {
        Init(sB);
    }

    DocScroller(Window* parent, int w, int h, int sB=3+12) :
        ScrollWnd(parent, w, h, true, (sB&1)?1:0, (sB&2)?1:0)
    {
        Init(sB);
    }

    DocScroller(Window* parent,int x,int y,int w,int h,int sB=3+12):
        ScrollWnd(parent, x, y, w, h, true, (sB&1)?1:0, (sB&2)?1:0)
    {
        Init(sB);
    }

    void SetDoc(DocDimensions* doc)
    {
        mDoc = doc;
    }

    void SetPageDeltas(int hor, int ver)
    {
        if (hor != RETAIN)
            mHorPageDelta = hor;
        if (ver != RETAIN)
            mVerPageDelta = ver;
    }

    void GetPageDeltas(int& hor, int& ver)
    {
        hor = mHorPageDelta;
        ver = mVerPageDelta;
    }

    virtual void SetContentPane(Window *nwPane, bool delOldContent=true,
                                bool doLayout=true)
    {
        ScrollWnd::SetContentPane(nwPane,delOldContent,doLayout);
        if (doLayout)
            mContent->ConnectTo(mHolder);
    }

    virtual void OnScroll(ScrollBar *src, int position, void* userData)
    {
        if (mAdjusting) return;
        if (src == mHorizontalScrollBar)
            mDoc->DocX(-position);
        if (src == mVerticalScrollBar)
        {
            int nPos = -mDoc->DocH() + mHolder->H() + position;
            mDoc->DocY(nPos);
        }
    }
/*
virtual void DisplayFunc()
{
    int     docX, docY, docW, docH;
    int     hX, hY, hW, hH;
    int     totalRange;

    mDoc->GetDocDimensions(docX, docY, docW, docH);
    mHolder->GetDimensions(hX, hY, hW, hH);

    if (mHorizontalScrollBar){
        int lineIncr = mHorizontalScrollBar->LineIncrement();
        totalRange = docW - ((mPartial&1) ? hW-2*lineIncr : 0);
        mHorizontalScrollBar->SetNewPos(-docX);
        mHorizontalScrollBar->SetRange(totalRange, hW - lineIncr);
    }
    if (mVerticalScrollBar){
        int nPos = docH - hH + docY;
        int lineIncr = mVerticalScrollBar->LineIncrement();
        totalRange = docH + ((mPartial&2) ? hH-2*lineIncr: 0);
        mVerticalScrollBar->SetNewPos(nPos);
        mVerticalScrollBar->SetRange(totalRange, hH - lineIncr);
    }

    mDoc->SetDocDimensions(docX, docY, docW, docH);
    Window::DisplayFunc();
}
*/

    virtual void FollowContent()
    {
        int     docX, docY, docW, docH;
        int     hX, hY, hW, hH;
        int     totalRange;

        mDoc->GetDocDimensions(docX, docY, docW, docH);
        mHolder->GetDimensions(hX, hY, hW, hH);

        if (mHorizontalScrollBar){
            int lineIncr = mHorizontalScrollBar->LineIncrement();
            totalRange = docW - ((mPartial&1) ? hW-2*lineIncr : 0);
            mHorizontalScrollBar->SetRange(totalRange, hW - mHorPageDelta);
            mHorizontalScrollBar->SetNewPos(-docX);
        }
        if (mVerticalScrollBar){
            int nPos = docH - hH + docY;
            int lineIncr = mVerticalScrollBar->LineIncrement();
            totalRange = docH + ((mPartial&2) ? hH-2*lineIncr: 0);
            mVerticalScrollBar->SetRange(totalRange, hH - mVerPageDelta);
            mVerticalScrollBar->SetNewPos(nPos);
        }
    }

    virtual void FollowScrollBar()
    {
        if (!mDoc) return;

        int     cX, cY, cW, cH;
        int     hX, hY, hW, hH;
        mDoc->GetDocDimensions(cX, cY, cW, cH);
        mHolder->GetDimensions(hX, hY, hW, hH);

        if (mHorizontalScrollBar)
        {
            mHorizontalScrollBar->SetRange(cW, hW - mHorPageDelta);
            cX = -mHorizontalScrollBar->GetValue();
        }
        if (mVerticalScrollBar)
        {
            mVerticalScrollBar->SetRange(cH, hH - mVerPageDelta);
            cY = mVerticalScrollBar->GetValue() + hH - cH;
        }
        else
            cY = hH - cH;
        mDoc->DocX(cX);
        mDoc->DocY(cY);
    }

    // RvB: Could be moved to ScrollBar to also have partial page_up/down there
    // Its FollowContent would also have to be changed
    void SetPartialPageUpDown(bool horizontal, bool vertical)
    {
        mPartial = 0;
        if (horizontal)
            mPartial |= 1;
        if (vertical)
            mPartial |= 2;
    }

protected:
    DocDimensions*  mDoc;       // The interface we work upon
    int             mPartial;   // On pagedown scroll somewhat less than page
    int             mVerPageDelta;
    int             mHorPageDelta;

private:
    void Init(int sB)
    {
        mDoc = 0;
        mPartial = (sB & 12) >> 2;
        mVerPageDelta = 16;
        mHorPageDelta = 16;
    }

};

} // Namespace OglGui
#endif

---