CSettings Class Reference

#include <Settings.h>

Collaboration diagram for CSettings:

[legend]

List of all members.

Public Member Functions
	CSettings (void)
	~CSettings (void)
void	setNewZoom (const double z)
GBool	zoomBack ()
GBool	canZoomBack ()
int	getZoomBackState () const
void	disableZoomBack ()
double	getZoom () const
void	setZoom (const double z)
void	load (const char *manifest)
void	save (const char *manifest)
int	getRotate () const
void	setRotate (const int r)
void	getScreenRect (rectangle &rect)
int	getScreenX () const
int	getScreenY () const
int	getScreenWidth () const
int	getScreenHeight () const
void	setScreenX (const int x)
void	setScreenY (const int y)
void	moveScreenX (const int d)
void	moveScreenY (const int d)
void	setScreenPosition (const int, const int)
void	setScreenSize (const int, const int)
void	setScreenRect (const rectangle &rect)
int	getCurrentPage () const
void	setCurrentPage (const int p)
int	getRenderDir () const
void	setRenderDir (const int d)
int	getMode () const
void	setMode (const int m)
GBool	isScribbleEnabled () const
void	addNewItem (HistoryItemPtr ptr)
void	addNewItem (const int page)
HistoryItemPtr	goBackward ()
HistoryItemPtr	goForward ()
GBool	canGoBack ()
GBool	canGoForward ()
Private Member Functions
void	clearHistory ()
Private Attributes
double	zoom
int	rotate
int	screenX
int	screenY
int	drawAreaWidth
int	drawAreaHeight
int	currentPage
int	renderDir
int	mode
int	zbState
GBool	enableScb
GooList	backward
GooList	forward
HistoryItemPtr	currentItem
HistoryItem	record

---

Detailed Description

Definition at line 123 of file Settings.h.

---

Constructor & Destructor Documentation

CSettings::CSettings

(

void

)

Definition at line 50 of file Settings.cpp.

{
    zoom = ZoomPage; rotate = 0; screenX = screenY = 0;
    currentPage = INVALID_PAGE_NUMBER; 
    drawAreaWidth = SCREEN_WIDTH;
    drawAreaHeight = CLIENT_AREA; 
    renderDir = RenderNext; 
    mode = ModePage; zbState = iconState_grey;
    enableScb = gTrue; currentItem = 0; 
}

CSettings::~CSettings

(

void

)

Definition at line 61 of file Settings.cpp.

{
    clearHistory();
}

Here is the call graph for this function:

---

Member Function Documentation

void CSettings::clearHistory

(

)

[private]

Definition at line 303 of file Settings.cpp.

{
    // clear the forward list.
    HistoryItemPtr ptr = 0;
    while (forward.getLength() > 0)
    {      
        ptr = (HistoryItemPtr)forward.del(0);
        delete ptr;
    }

    // clear backward list
    while (backward.getLength() > 0)
    {      
        ptr = (HistoryItemPtr)backward.del(0);
        delete ptr;
    }

    // clear current item
    delete currentItem;
    currentItem = 0;

#if (HISTORY_DEBUG)
    // Count should reach 1, because the member variable record is still not released.
    printf("\n\nHistoryItem count reaches %d\n\n", HistoryItem::count);
#endif    
}

void CSettings::setNewZoom

(

const double

z

)

Definition at line 66 of file Settings.cpp.

{
    record.zoom = zoom;
    zoom = z; 
    record.x = screenX; 
    record.y = screenY;
    zbState = iconState_normal; 
}

GBool CSettings::zoomBack

(

)

Definition at line 75 of file Settings.cpp.

{
    if (InvalidZoom == record.zoom)
    {
        return gFalse;
    }

    if (mode == ModePage)
    {
        swap(zoom, record.zoom);
        swap(screenX, record.x);
        swap(screenY, record.y);
    }
    else 
    {
        double ratio = record.zoom / zoom;
        swap(zoom, record.zoom);
        if (rotate == 270)
        {
            record.x = (int)(screenX * ratio);
            swap(screenX, record.x);
            swap(screenY, record.y);
        }
        else if (rotate == 0)
        {          
            record.y = (int)(screenY * ratio);
            swap(screenY, record.y);
            swap(screenX, record.x);
        }            
    }
    if (iconState_normal == zbState)
    {
        zbState = iconState_selected;
    }
    else if (iconState_selected == zbState)
    {
        zbState = iconState_normal;
    }
    return gTrue;
}

Here is the call graph for this function:

GBool CSettings::canZoomBack

(

)

Definition at line 122 of file Settings.cpp.

{
    return (InvalidZoom != record.zoom);
}

int CSettings::getZoomBackState

(

)

const [inline]

Definition at line 154 of file Settings.h.

{ return zbState; }

void CSettings::disableZoomBack

(

)

Definition at line 116 of file Settings.cpp.

{
    record.zoom = InvalidZoom;
    zbState = iconState_grey;
}

double CSettings::getZoom

(

)

const [inline]

Definition at line 156 of file Settings.h.

{ return zoom; }

void CSettings::setZoom

(

const double

z

)

[inline]

Definition at line 157 of file Settings.h.

{ zoom = z; }

void CSettings::load

(

const char *

manifest

)

Definition at line 127 of file Settings.cpp.

{
    erManifest manifest;
    if (RET_OK == ermXmlOpenManifest(pathName, &manifest))
    {
        // usually the manifest file is existing
        ermXmlGetInt(&manifest, "/package/last-location/pagenumber", &currentPage);
    
        // zoom
        static const int MAX = 20;
        char tmp[MAX] = {0};
        ermXmlGetString(&manifest, "/package/viewer-settings/zoomfactor", tmp, MAX);
        
        if (0 == strcasecmp(tmp, "zoomPage"))
        {
            zoom = ZoomPage;
        }
        else if (0 == strcasecmp(tmp, "zoomWidth"))
        {
            zoom = ZoomWidth;
        }
        else
        {
            sscanf(tmp, "%lf", &zoom);
        }
        
        // rotation , position and mode
        ermXmlGetInt(&manifest, "/package/viewer-settings/rotation", &rotate);
        ermXmlGetInt(&manifest, "/package/viewer-settings/positionx", &screenX);
        ermXmlGetInt(&manifest, "/package/viewer-settings/positiony", &screenY);
        ermXmlGetString(&manifest, "/package/viewer-settings/mode", tmp, MAX);
        
        if (0 == strcasecmp(tmp, "continous"))
        {
            mode = ModeContinous;
        }
        else if (0 == strcasecmp(tmp, "page"))
        {
            mode = ModePage;
        }

        // check scribble state at first.
        // if the string contains any invalid characters, just disable scribble.
        enableScb = gTrue;
        if (RET_OK == ermXmlGetString(&manifest, "/package/metadata/y-metadata/modify-enable/scribble-enable", tmp, MAX))
        {
            if (strncmp(tmp, "true", MAX) != 0)
            {
                enableScb = gFalse;
            }
        }
        // if children nodes are not available, check parent node.
        else if (RET_OK == ermXmlGetAttributeString(&manifest, 
                        "/package/metadata/y-metadata/modify-enable",
                        "default", tmp, MAX))
        {
            if (strncmp(tmp, "true", MAX) != 0)
            {
                enableScb = gFalse;
            }
        }
    }    
    ermXmlClose(&manifest);    
}

Here is the call graph for this function:

void CSettings::save

(

const char *

manifest

)

Definition at line 192 of file Settings.cpp.

{
    erManifest manifest;
    if (RET_OK == ermXmlOpenManifest(pathName, &manifest))
    {
        // usually the manifest file is existing
        
        // dump for debug
        // s.dump();
        
        // page
        if (RET_OK != ermXmlExist(&manifest, "/package/last-location/pagenumber"))
        {
            ermXmlNewString(&manifest, "/package", "last-location", "");            
            ermXmlNewString(&manifest, "/package/last-location", "pagenumber", "");            
        }
        ermXmlSetInt(&manifest, "/package/last-location/pagenumber", currentPage);                    

        // zoom 
        if (RET_OK != ermXmlExist(&manifest, "/package/viewer-settings/zoomfactor"))
        {
            ermXmlNewString(&manifest, "/package", "viewer-settings", "");            
            ermXmlNewString(&manifest, "/package/viewer-settings", "zoomfactor", "");            
        }
        if (zoom == ZoomPage)
        {
            ermXmlSetString(&manifest, "/package/viewer-settings/zoomfactor", "zoomPage");                    
        }
        else if (zoom == ZoomWidth)
        {
            ermXmlSetString(&manifest, "/package/viewer-settings/zoomfactor", "zoomWidth");                    
        }            
        else 
        {
            char tmp[20] = {0};
            snprintf(tmp, 20, "%lf", zoom);
            ermXmlSetString(&manifest, "/package/viewer-settings/zoomfactor", tmp);                    
        }
        
        // rotation
        if (RET_OK != ermXmlExist(&manifest, "/package/viewer-settings/rotation"))
        {
            ermXmlNewString(&manifest, "/package/viewer-settings", "rotation", "");            
        }
        ermXmlSetInt(&manifest, "/package/viewer-settings/rotation", rotate);                    

        // position x
        if (RET_OK != ermXmlExist(&manifest, "/package/viewer-settings/positionx"))
        {
            ermXmlNewString(&manifest, "/package/viewer-settings", "positionx", "");            
        }
        ermXmlSetInt(&manifest, "/package/viewer-settings/positionx", screenX);                    

        // position y
        if (RET_OK != ermXmlExist(&manifest, "/package/viewer-settings/positiony"))
        {
            ermXmlNewString(&manifest, "/package/viewer-settings", "positiony", "");            
        }
        ermXmlSetInt(&manifest, "/package/viewer-settings/positiony", screenY);                    

        // mode
        if (RET_OK != ermXmlExist(&manifest, "/package/viewer-settings/mode"))
        {
            ermXmlNewString(&manifest, "/package/viewer-settings", "mode", "");            
        }
        if (mode == ModeContinous)
        {
            ermXmlSetString(&manifest, "/package/viewer-settings/mode", "continous");
        }
        else 
        {
            ermXmlSetString(&manifest, "/package/viewer-settings/mode", "page");
        }

        ermXmlSaveAndClose(&manifest);
    }     
}

Here is the call graph for this function:

int CSettings::getRotate

(

)

const [inline]

Definition at line 164 of file Settings.h.

{ return rotate; }

void CSettings::setRotate

(

const int

r

)

[inline]

Definition at line 165 of file Settings.h.

{ rotate = r; }

void CSettings::getScreenRect

(

rectangle &

rect

)

Definition at line 270 of file Settings.cpp.

{
    if (getRotate() == 0 || getRotate() == 180)
    {
        rect.left = screenX; rect.top = screenY;
        rect.right = screenX + drawAreaWidth;
        rect.bottom = screenY + drawAreaHeight;
    }
    else if (getRotate() == 90 || getRotate() == 270)
    {
        rect.left = screenY; rect.top = screenX; 
        rect.right = screenY + drawAreaHeight;
        rect.bottom = screenX + drawAreaWidth;
    }        
}

Here is the call graph for this function:

int CSettings::getScreenX

(

)

const [inline]

Definition at line 169 of file Settings.h.

{ return screenX; }

int CSettings::getScreenY

(

)

const [inline]

Definition at line 170 of file Settings.h.

{ return screenY; }

int CSettings::getScreenWidth

(

)

const [inline]

Definition at line 171 of file Settings.h.

{ return drawAreaWidth; }

int CSettings::getScreenHeight

(

)

const [inline]

Definition at line 172 of file Settings.h.

{ return drawAreaHeight; }

void CSettings::setScreenX

(

const int

x

)

[inline]

Definition at line 173 of file Settings.h.

{ screenX = x; }

void CSettings::setScreenY

(

const int

y

)

[inline]

Definition at line 174 of file Settings.h.

{ screenY = y; }

void CSettings::moveScreenX

(

const int

d

)

[inline]

Definition at line 175 of file Settings.h.

{ screenX += d; }

void CSettings::moveScreenY

(

const int

d

)

[inline]

Definition at line 176 of file Settings.h.

{ screenY += d; }

void CSettings::setScreenPosition	(	const int	nX,
		const int	nY
	)

Definition at line 286 of file Settings.cpp.

{
    screenX = nX; screenY = nY;
}

void CSettings::setScreenSize	(	const int	width,
		const int	height
	)

Definition at line 291 of file Settings.cpp.

{
    drawAreaWidth = width; drawAreaHeight = height;
}

void CSettings::setScreenRect

(

const rectangle &

rect

)

Definition at line 296 of file Settings.cpp.

{
    screenX = rect.left; screenY = rect.top;
    drawAreaWidth = rect.right - rect.left; 
    drawAreaHeight = rect.bottom - rect.top;
}

int CSettings::getCurrentPage

(

)

const [inline]

Definition at line 182 of file Settings.h.

{ return currentPage; }

void CSettings::setCurrentPage

(

const int

p

)

Definition at line 331 of file Settings.cpp.

{
    // page change signal.
    if (currentPage != p && currentPage != INVALID_PAGE_NUMBER)
    {
        // add the current one into history list.
        addNewItem(currentPage);
    }

    if (currentItem == 0)
    {
        currentItem = new HistoryItem;
    }   

    // always update the page number.
    currentItem->pageNumber = p;           
    currentPage = p;

#if (HISTORY_DEBUG)
    dumpHistory();
#endif
}

Here is the call graph for this function:

int CSettings::getRenderDir

(

)

const [inline]

Definition at line 186 of file Settings.h.

{ return renderDir; }

void CSettings::setRenderDir

(

const int

d

)

[inline]

Definition at line 187 of file Settings.h.

{ renderDir =d ;  }

int CSettings::getMode

(

)

const [inline]

Definition at line 190 of file Settings.h.

{ return mode; }

void CSettings::setMode

(

const int

m

)

[inline]

Definition at line 191 of file Settings.h.

{ mode = m; }

GBool CSettings::isScribbleEnabled

(

)

const [inline]

Definition at line 194 of file Settings.h.

{ return enableScb; }

void CSettings::addNewItem

(

HistoryItemPtr

ptr

)

Definition at line 355 of file Settings.cpp.

{
    // check length before adding new one.
    if (backward.getLength() >= HISTORY_MAX_LENGTH)
    {
        delete (HistoryItemPtr)backward.del(0);
    }

    backward.append(ptr);

    // clear the forward list.
    while (forward.getLength() > 0)
    {      
        ptr = (HistoryItemPtr)forward.del(0);
        delete ptr;
    }
}

void CSettings::addNewItem

(

const int

page

)

Definition at line 373 of file Settings.cpp.

{
    HistoryItemPtr ptr = new HistoryItem;
    ptr->pageNumber = page;
    addNewItem(ptr);
}

Here is the call graph for this function:

HistoryItemPtr CSettings::goBackward

(

)

Definition at line 380 of file Settings.cpp.

{
    int last = backward.getLength();
    if (last <= 0)
    {
        return 0;
    }

    forward.append(currentItem);  
    currentItem = (HistoryItemPtr)backward.del(last - 1);
    currentPage = currentItem->pageNumber;
    return currentItem;
}

HistoryItemPtr CSettings::goForward

(

)

Definition at line 394 of file Settings.cpp.

{
    int last = forward.getLength();
    if (last <= 0)
    {
        return 0;
    }

    backward.append(currentItem);
    currentItem = (HistoryItemPtr)forward.del(last - 1);
    currentPage = currentItem->pageNumber;
    return currentItem;
}

GBool CSettings::canGoBack

(

)

Definition at line 408 of file Settings.cpp.

{
    return (backward.getLength() > 0);
}

GBool CSettings::canGoForward

(

)

Definition at line 413 of file Settings.cpp.

{
    return (forward.getLength() > 0);
}

---

Member Data Documentation

double CSettings::zoom [private]

Definition at line 126 of file Settings.h.

int CSettings::rotate [private]

Definition at line 127 of file Settings.h.

int CSettings::screenX [private]

Definition at line 128 of file Settings.h.

int CSettings::screenY [private]

Definition at line 129 of file Settings.h.

int CSettings::drawAreaWidth [private]

Definition at line 130 of file Settings.h.

int CSettings::drawAreaHeight [private]

Definition at line 131 of file Settings.h.

int CSettings::currentPage [private]

Definition at line 132 of file Settings.h.

int CSettings::renderDir [private]

Definition at line 133 of file Settings.h.

int CSettings::mode [private]

Definition at line 134 of file Settings.h.

int CSettings::zbState [private]

Definition at line 135 of file Settings.h.

GBool CSettings::enableScb [private]

Definition at line 136 of file Settings.h.

GooList CSettings::backward [private]

Definition at line 137 of file Settings.h.

GooList CSettings::forward [private]

Definition at line 138 of file Settings.h.

HistoryItemPtr CSettings::currentItem [private]

Definition at line 140 of file Settings.h.

HistoryItem CSettings::record [private]

Definition at line 141 of file Settings.h.

---

The documentation for this class was generated from the following files:

• ipdf-svn/inc/Settings.h
• ipdf-svn/src/Settings.cpp