Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

ColorList Class Reference

#include <sccolor.h>

List of all members.

Public Member Functions

 ColorList (ScribusDoc *doc=NULL, bool retainDoc=false)
ColorListoperator= (const ColorList &list)
ScribusDocdocument (void)
 Get the document the list is related , return in cpp due to scribusdoc class delcaration.
void setDocument (ScribusDoc *doc)
 Assign the doc to which the list belong to.
void addColors (const ColorList &colorList, bool overwrite=TRUE)
 Add colors from the specified list. Colors are added using shadow copy.
void copyColors (const ColorList &colorList, bool overwrite=TRUE)
 Copy colors from the specified list.
void ensureBlackAndWhite (void)
 Ensure availability of black and white colors.

Protected Member Functions

void ensureBlack (void)
 Ensure availability of black color.
void ensureWhite (void)
 Ensure availability of white color.

Protected Attributes

QPointer< ScribusDocm_doc
bool m_retainDoc


Detailed Description

Definition at line 138 of file sccolor.h.


Constructor & Destructor Documentation

ColorList::ColorList ( ScribusDoc doc = NULL,
bool  retainDoc = false 
)

Definition at line 287 of file sccolor.cpp.

References m_doc, and m_retainDoc.


Member Function Documentation

void ColorList::ensureBlack ( void   )  [protected]

Ensure availability of black color.

Definition at line 336 of file sccolor.cpp.

References colorModelCMYK, ScColor::getCMYK(), and ScColor::getColorModel().

Referenced by ensureBlackAndWhite().

void ColorList::ensureWhite ( void   )  [protected]

Ensure availability of white color.

Definition at line 356 of file sccolor.cpp.

References colorModelCMYK, ScColor::getCMYK(), and ScColor::getColorModel().

Referenced by ensureBlackAndWhite().

ColorList & ColorList::operator= ( const ColorList list  ) 

Definition at line 298 of file sccolor.cpp.

References addColors(), m_doc, and m_retainDoc.

ScribusDoc * ColorList::document ( void   ) 

void ColorList::setDocument ( ScribusDoc doc  ) 

Assign the doc to which the list belong to.

Definition at line 293 of file sccolor.cpp.

References m_doc.

Referenced by ScribusDoc::getUsedColors(), and ScribusDoc::setup().

void ColorList::addColors ( const ColorList colorList,
bool  overwrite = TRUE 
)

Add colors from the specified list. Colors are added using shadow copy.

Definition at line 307 of file sccolor.cpp.

Referenced by copyColors(), Serializer::importCollection(), and operator=().

void ColorList::copyColors ( const ColorList colorList,
bool  overwrite = TRUE 
)

Copy colors from the specified list.

Definition at line 319 of file sccolor.cpp.

References addColors().

void ColorList::ensureBlackAndWhite ( void   ) 

Ensure availability of black and white colors.

Definition at line 330 of file sccolor.cpp.

References ensureBlack(), and ensureWhite().

Referenced by ColorManager::deleteUnusedColors(), WMFImport::importWMF(), ScribusDoc::init(), PrefsManager::ReadPref(), and ScribusDoc::setup().


Member Data Documentation

QPointer<ScribusDoc> ColorList::m_doc [protected]

Definition at line 141 of file sccolor.h.

Referenced by ColorList(), document(), operator=(), and setDocument().

bool ColorList::m_retainDoc [protected]

Definition at line 142 of file sccolor.h.

Referenced by ColorList(), and operator=().


The documentation for this class was generated from the following files:
Created with personalized Doxygen. This is documentation for GPL software Scribus - Open Source Desktop Publishing.