UT_StringPager.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_StringPager.h ( Utility Library, C++ )
 *
 * COMMENTS:
 *      A fixed-width pager, in the sense of less or more, that lets
 *      one dump text to it and then retrieve in a word-wrapped manner.
 */

#ifndef __UT_StringPager_h__
#define __UT_StringPager_h__

#include "UT_API.h"

#include "UT_Assert.h"
#include "UT_StringHolder.h"
#include "UT_StringArray.h"
#include "UT_WorkBuffer.h"

#include <SYS/SYS_Inline.h>
#include <SYS/SYS_String.h>
#include <SYS/SYS_Types.h>

class UT_API UT_StringPager
{
public:
    UT_StringPager(int width = 80, int leftmargin = 0, int rightmargin = 3)
            : myWidth(width) 
            , myLeftMargin(leftmargin)
            , myRightMargin(rightmargin)
            {}

    int                 getLeftMargin() const { return myLeftMargin; }
    int                 getRightMargin() const { return myRightMargin; }
    int                 getWidth() const { return myWidth; }

    // This only affects future appended text, not the existing paged data.
    void                setLeftMargin(int leftmargin) { myLeftMargin = leftmargin; }
    void                setRightMargin(int rightmargin) { myRightMargin = rightmargin; }
    void                setWidth(int width) { myWidth = width; }

    UT_StringHolder     getLine(exint line) const;
    exint               numLines() const { return myLines.entries()+1; }
    void                clear();

    // Returns all the lines joined with \n
    // No \n on final line.  (so empty -> empty)
    UT_StringHolder     buildText() const;

    // Explicitly append provided text
    void                appendText(const char *text);
    
    // Appends a new line
    void                newLine();

private:
    // Formatting options
    int                 myWidth;
    int                 myLeftMargin, myRightMargin;

    // Current text buffer, myCurLine is always the last line.
    UT_StringArray      myLines;
    UT_WorkBuffer       myCurLine;
};

#endif