ads::internal Namespace Reference

Classes
class	CDockInsertParam

Enumerations
enum	eRepolishChildOptions { RepolishIgnoreChildren, RepolishDirectChildren, RepolishChildrenRecursively }

Functions
QPixmap	createTransparentPixmap (const QPixmap &Source, qreal Opacity)
CDockInsertParam	dockAreaInsertParameters (DockWidgetArea Area)
template<class T >
T	findParent (const QWidget *w)
void	hideEmptyParentSplitters (CDockSplitter *FirstParentSplitter)
void	replaceSplitterWidget (QSplitter *Splitter, QWidget *From, QWidget *To)
void	repolishStyle (QWidget *w, eRepolishChildOptions Options=RepolishIgnoreChildren)
void	setButtonIcon (QAbstractButton *Button, QStyle::StandardPixmap StandarPixmap, ads::eIcon CustomIconId)
template<class T >
void	setFlag (T &Flags, typename T::enum_type flag, bool on=true)
template<class QObjectPtr >
void	setToolTip (QObjectPtr obj, const QString &tip)

Variables
static const char *const	ClosedProperty = "close"
static const char *const	DirtyProperty = "dirty"
static const bool	Restore = false
static const bool	RestoreTesting = true

Enumeration Type Documentation

eRepolishChildOptions

enum ads::internal::eRepolishChildOptions

Enumerator
RepolishIgnoreChildren
RepolishDirectChildren
RepolishChildrenRecursively

Definition at line 280 of file ads_globals.h.

Function Documentation

createTransparentPixmap()

QPixmap ads::internal::createTransparentPixmap	(	const QPixmap &	Source,
		qreal	Opacity
	)

Creates a semi transparent pixmap from the given pixmap Source. The Opacity parameter defines the opacity from completely transparent (0.0) to completely opaque (1.0)

Definition at line 316 of file ads_globals.cpp.

dockAreaInsertParameters()

CDockInsertParam ads::internal::dockAreaInsertParameters

(

DockWidgetArea

Area

)

Returns the insertion parameters for the given dock area

Definition at line 299 of file ads_globals.cpp.

findParent()

template<class T >

T ads::internal::findParent

(

const QWidget *

w

)

Searches for the parent widget of the given type. Returns the parent widget of the given widget or 0 if the widget is not child of any widget of type T

It is not safe to use this function in in CDockWidget because only the current dock widget has a parent. All dock widgets that are not the current dock widget in a dock area have no parent.

Definition at line 203 of file ads_globals.h.

hideEmptyParentSplitters()

void ads::internal::hideEmptyParentSplitters

(

CDockSplitter *

FirstParentSplitter

)

This function walks the splitter tree upwards to hides all splitters that do not have visible content

Definition at line 328 of file ads_globals.cpp.

replaceSplitterWidget()

void ads::internal::replaceSplitterWidget	(	QSplitter *	Splitter,
		QWidget *	From,
		QWidget *	To
	)

Replace the from widget in the given splitter with the To widget

Definition at line 291 of file ads_globals.cpp.

repolishStyle()

void ads::internal::repolishStyle	(	QWidget *	w,
		eRepolishChildOptions	Options = RepolishIgnoreChildren
	)

Calls unpolish() / polish for the style of the given widget to update stylesheet if a property changes

Definition at line 367 of file ads_globals.cpp.

setButtonIcon()

void ads::internal::setButtonIcon	(	QAbstractButton *	Button,
		QStyle::StandardPixmap	StandarPixmap,
		ads::eIcon	CustomIconId
	)

Helper function to set the icon of a certain button. Use this function to set the icons for the dock area and dock widget buttons. The function first uses the CustomIconId to get an icon from the CIconProvider. You can register your custom icons with the icon provider, if you do not want to use the default buttons and if you do not want to use stylesheets. If the IconProvider does not return a valid icon (icon is null), the function fetches the given standard pixmap from the QStyle. param[in] Button The button whose icons are to be set param[in] StandardPixmap The standard pixmap to be used for the button param[in] CustomIconId The identifier for the custom icon.

Definition at line 342 of file ads_globals.cpp.

setFlag()

template<class T >

void ads::internal::setFlag	(	T &	Flags,
		typename T::enum_type	flag,
		bool	on = true
	)

Helper function for settings flags in a QFlags instance.

Definition at line 230 of file ads_globals.h.

setToolTip()

template<class QObjectPtr >

void ads::internal::setToolTip	(	QObjectPtr	obj,
		const QString &	tip
	)

Helper function for settings tooltips without cluttering the code with tests for preprocessor macros

Definition at line 252 of file ads_globals.h.

Variable Documentation

ClosedProperty

const char* const ads::internal::ClosedProperty = "close"

static

Definition at line 134 of file ads_globals.h.

DirtyProperty

const char* const ads::internal::DirtyProperty = "dirty"

static

Definition at line 135 of file ads_globals.h.

Restore

const bool ads::internal::Restore = false

static

Definition at line 133 of file ads_globals.h.

RestoreTesting

const bool ads::internal::RestoreTesting = true

static

Definition at line 132 of file ads_globals.h.