XTARGS Class Reference

Class to contain XtArg array. More...

#include <mi32/xtargs.h>

List of all members.

Public Member Functions
	XTARGS (const Arg *arg, int count)
	XTARGS ()
void	Append (const Arg &arg)
void	Append (const char *name, int value)
void	Append (const char *name, void *value)
void	Assign (const Arg *arg, int count)
void	Clear ()
void	DeleteItem (int idx)
int	FindItem (const char *name) const
void	FormAttachBottom (Widget widget=0, int offset=-1, bool opposite=false)
void	FormAttachBottomPosition (int position, int offset=-1)
void	FormAttachLeft (Widget widget=0, int offset=-1, bool opposite=false)
void	FormAttachLeftPosition (int position, int offset=-1)
void	FormAttachRight (Widget widget=0, int offset=-1, bool opposite=false)
void	FormAttachRightPosition (int position, int offset=-1)
void	FormAttachTop (Widget widget=0, int offset=-1, bool opposite=false)
void	FormAttachTopPosition (int position, int offset=-1)
Arg *	GetArray ()
const Arg *	GetArray () const
int	GetCount () const
const Arg &	GetItem (int idx) const
void	GetWidgetValues (Widget widget)
	operator Arg * ()
	operator const Arg * () const
const Arg &	operator[] (int index) const
void	SetWidgetValues (Widget widget)

---

Detailed Description

Class to contain XtArg array.

---

Constructor & Destructor Documentation

XTARGS::XTARGS

(

)

[inline]

Default constructor, creates empty array.

XTARGS::XTARGS	(	const Arg *	arg,
		int	count
	)			[inline]

Construct from Arg array and count.

Parameters:

	arg	Argument array
	count	Number of items to copy from

---

Member Function Documentation

void XTARGS::Append

(

const Arg &

arg

)

[inline]

Append Arg to array.

void XTARGS::Append	(	const char *	name,
		int	value
	)			[inline]

Append item to array.

Parameters:

	name	Argument name
	value	Value

void XTARGS::Append	(	const char *	name,
		void *	value
	)			[inline]

Append item to array.

Parameters:

	name	Argument name
	value	Value

void XTARGS::Assign	(	const Arg *	arg,
		int	count
	)			[inline]

Assign from Arg array and count.

Parameters:

	arg	Argument array
	count	Number of items to copy from

void XTARGS::Clear

(

)

[inline]

Clear argument list.

void XTARGS::DeleteItem

(

int

idx

)

Delete item at specified index.

int XTARGS::FindItem

(

const char *

name

)

const

Find item in array by name.

Returns:

Index to item or -1 if not found.

void XTARGS::FormAttachBottom	(	Widget	widget = 0,
		int	offset = -1,
		bool	opposite = false
	)

Add form attachment parameters for bottom.

Parameters:

	widget	Widget to attach to, 0 for parent form itself
	offset	Offset, -1 to use parent form spacing
	opposite	'true' for opposite-side attachment

void XTARGS::FormAttachBottomPosition	(	int	position,
		int	offset = -1
	)

Add form attachment parameters for bottom by position.

Parameters:

	position	Position relative to fraction base
	offset	Offset, -1 to use parent form spacing

void XTARGS::FormAttachLeft	(	Widget	widget = 0,
		int	offset = -1,
		bool	opposite = false
	)

Add form attachment parameters for left.

Parameters:

	widget	Widget to attach to, 0 for parent form itself
	offset	Offset, -1 to use parent form spacing
	opposite	'true' for opposite-side attachment

void XTARGS::FormAttachLeftPosition	(	int	position,
		int	offset = -1
	)

Add form attachment parameters for left by position.

Parameters:

	position	Position relative to fraction base
	offset	Offset, -1 to use parent form spacing

void XTARGS::FormAttachRight	(	Widget	widget = 0,
		int	offset = -1,
		bool	opposite = false
	)

Add form attachment parameters for right.

Parameters:

	widget	Widget to attach to, 0 for parent form itself
	offset	Offset, -1 to use parent form spacing
	opposite	'true' for opposite-side attachment

void XTARGS::FormAttachRightPosition	(	int	position,
		int	offset = -1
	)

Add form attachment parameters for right by position.

Parameters:

	position	Position relative to fraction base
	offset	Offset, -1 to use parent form spacing

void XTARGS::FormAttachTop	(	Widget	widget = 0,
		int	offset = -1,
		bool	opposite = false
	)

Add form attachment parameters for top.

Parameters:

	widget	Widget to attach to, 0 for parent form itself
	offset	Offset, -1 to use parent form spacing
	opposite	'true' for opposite-side attachment

void XTARGS::FormAttachTopPosition	(	int	position,
		int	offset = -1
	)

Add form attachment parameters for top by position.

Parameters:

	position	Position relative to fraction base
	offset	Offset, -1 to use parent form spacing

Arg* XTARGS::GetArray

(

)

[inline]

Get XtArg array.

const Arg* XTARGS::GetArray

(

)

const [inline]

Get XtArg array.

int XTARGS::GetCount

(

)

const [inline]

Get number of items in array.

const Arg& XTARGS::GetItem

(

int

idx

)

const [inline]

Get item from array.

void XTARGS::GetWidgetValues

(

Widget

widget

)

[inline]

Get values from widget.

XTARGS::operator Arg *

(

)

[inline]

Non-constant cast to Arg*.

XTARGS::operator const Arg *

(

)

const [inline]

Constant cast to Arg*.

const Arg& XTARGS::operator[]

(

int

index

)

const [inline]

Read (const) access to array element.

Note:

Does not verify that index is within valid range. GENERATING_DOXYGEN_OUTPUT

void XTARGS::SetWidgetValues

(

Widget

widget

)

[inline]

Set values to widget.

---

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

• mi32/xtargs.h