MergeSettings Class Reference

Holds a map between all the auto-merge types currently defined and their default values. More...

#include <Tools/WorkflowMerge/mergesettings.h>

Inheritance diagram for MergeSettings:

Public Member Functions
	MergeSettings (QSettings &settings, bool load=true)
bool	allowAutoMerge (AutoMergeType key) const
AutoMerge	autoMerge (AutoMergeType key) const
AutoMergeDefaultResponse	autoMergeDefault (AutoMergeType key) const
void	clearBlockingTypes () const
bool	createDefaults (bool saveSettings)
QString	defaultString (AutoMergeType key) const
AutoMergeRole	getBlockingRole () const
QString	getBlockingTag () const
QString	getBlockingType () const
bool	hasType (AutoMergeType type) const
bool	load ()
QMap< QString, QList< AutoMergeType > >	mappedTypes () const
int	numTypes () const
QString	prompt (AutoMergeType key) const
bool	save ()
void	setBlockingType (AutoMergeType type) const
void	setDefault (AutoMergeType type, AutoMergeDefaultResponse mergeDefault, bool allowAutoMerge, const QString &prompt, const QString &prefix)
int	setDefault (const QString &itemTag, AutoMergeRole role, AutoMergeDefaultResponse mergeDefault, bool allowAutoMerge, const QString &prompt, const QString &prefix)
int	setDefault (const QString &itemTag, const QString &customRoleName, AutoMergeDefaultResponse mergeDefault, bool allowAutoMerge, const QString &prompt, const QString &prefix)
QList< AutoMergeType >	types () const
void	update (AutoMergeType type, AutoMergeDefaultResponse mergeDefault, bool allowAutoMerge)
void	update (const QString &itemTag, AutoMergeRole role, AutoMergeDefaultResponse mergeDefault, bool allowAutoMerge)
void	update (const QString &itemTag, QString customRoleName, AutoMergeDefaultResponse mergeDefault, bool allowAutoMerge)
Public Member Functions inherited from BasicTextLogger
	BasicTextLogger ()
virtual	~BasicTextLogger ()
void	logLine (const Application::LogManager::MessageCategory &category, const QString &msg) const
void	logLine (const QString &msg) const
void	logText (const Application::LogManager::MessageCategory &category, const QString &msg) const
void	logText (const QString &msg) const

Detailed Description

It can produce a set of initial default values and handles loading and saving the settings

Constructor & Destructor Documentation

MergeSettings()

MergeSettings	(	QSettings &	settings,
		bool	load = true
	)

Member Function Documentation

allowAutoMerge()

bool allowAutoMerge

(

AutoMergeType

key

)

const

Parameters

key	AutoMerge type

Returns

True if there is a possible automatic merge response to this type

autoMerge()

AutoMerge autoMerge

(

AutoMergeType

key

)

const

autoMergeDefault()

AutoMergeDefaultResponse autoMergeDefault

(

AutoMergeType

key

)

const

Returns the current action that the tool will take when faced with a possible merge of this type

Parameters

key	merge type

Returns

The current AutoMerge auto merge default settings for this type of workflow difference

clearBlockingTypes()

void clearBlockingTypes

(

)

const

createDefaults()

bool createDefaults

(

bool

saveSettings

)

defaultString()

QString defaultString

(

AutoMergeType

key

)

const

Returns a string representation of this type of merge action the system will take when treating a merge of this type

Parameters

key	AutoMerge type

Returns

A string representation of this type of workflow difference

getBlockingRole()

AutoMergeRole getBlockingRole

(

)

const

Returns

Last cause of merge failure as an int (the role of merge that was disallowed eg ItemRemovedFromOne)

getBlockingTag()

QString getBlockingTag

(

)

const

Returns

Last cause of merge failure

getBlockingType()

QString getBlockingType

(

)

const

Returns

Last cause of merge failure as a string ()

hasType()

bool hasType

(

AutoMergeType

type

)

const

load()

bool load

(

)

mappedTypes()

QMap< QString, QList< AutoMergeType > > mappedTypes

(

)

const

numTypes()

int numTypes

(

)

const

Returns

The number of different types of workflow differences currently mapped

prompt()

QString prompt

(

AutoMergeType

key

)

const

Returns a string representation of this type of merge

Parameters

key	AutoMerge type

Returns

The string prompt corresponding to this type of workflow difference

save()

bool save

(

)

setBlockingType()

void setBlockingType

(

AutoMergeType

type

)

const

setDefault() [1/3]

void setDefault	(	AutoMergeType	type,
		AutoMergeDefaultResponse	mergeDefault,
		bool	allowAutoMerge,
		const QString &	prompt,
		const QString &	prefix
	)

setDefault() [2/3]

int setDefault	(	const QString &	itemTag,
		AutoMergeRole	role,
		AutoMergeDefaultResponse	mergeDefault,
		bool	allowAutoMerge,
		const QString &	prompt,
		const QString &	prefix
	)

setDefault() [3/3]

int setDefault	(	const QString &	itemTag,
		const QString &	customRoleName,
		AutoMergeDefaultResponse	mergeDefault,
		bool	allowAutoMerge,
		const QString &	prompt,
		const QString &	prefix
	)

types()

QList< AutoMergeType > types

(

)

const

Returns

A list of the different types of workflow differences currently mapped

update() [1/3]

void update	(	AutoMergeType	type,
		AutoMergeDefaultResponse	mergeDefault,
		bool	allowAutoMerge
	)

update() [2/3]

void update	(	const QString &	itemTag,
		AutoMergeRole	role,
		AutoMergeDefaultResponse	mergeDefault,
		bool	allowAutoMerge
	)

update() [3/3]

void update	(	const QString &	itemTag,
		QString	customRoleName,
		AutoMergeDefaultResponse	mergeDefault,
		bool	allowAutoMerge
	)