k_element-rw.h File Reference

Element of iKlax File structure written management. More...

#include <kcolor.h>
#include "iklaxlib_global.h"
#include "KFile.h"

Enumerations
enum	KEltType {   KTYPE_TRACK, KTYPE_GROUP, KTYPE_IMPLY, KTYPE_EQUIV,   KTYPE_EXCLU, KTYPE_NOTMUTE, KTYPE_ERROR }
	Enumerator of element types in a KFile structure. More...
Functions
KL_API KBool	kelt_setDefaultLevel (KFile *pKFile, KCString sEltName, KLevel dLevel)
	Sets the default level of an element.
KL_API KBool	kelt_setColor (KFile *pKFile, KCString sEltName, KColor iColor)
	Sets a color to an element.
KL_API KColor	kelt_getColor (KFile *pKFile, KCString sEltName)
	Gets the color of an element.
KL_API KEltType	kelt_getType (KFile *pKFile, KCString sEltName)
	Gets the type of an element in a KFile structure.
KL_API KBool	kelt_hideElt (KFile *pKFile, KCString sEltName)
	Hides an element.
KL_API KBool	kelt_showElt (KFile *pKFile, KCString sEltName)
	Shows an element.
KL_API KBool	k_deleteElt (KFile *pKFile, KCString sEltName)
	Deletes a element from a KFile structure.
KL_API KBool	k_addTrackWithFilePath (KFile *pKFile, KCString sTrackName, const KUInt32 iDate, KCString sFileName)
	Adds a track with an associated audio file in a KFile structure.
KL_API KBool	k_renameElt (KFile *pKFile, KCString sOldName, KCString sNewName)
	Renames an element in a KFile structure.

---

Detailed Description

Element of iKlax File structure written management.

Version:

iKlaxLib-1.5

Author:

Fabien Gallot

Date:

15/01/2010

See also:

This file has been developed with KToolLib.

Note:

Copyright © 2008-2010 iKlax Media SAS (www.iklaxmedia.com). All rights reserved.

---

Enumeration Type Documentation

enum KEltType

Enumerator of element types in a KFile structure. Enumeration values: KTYPE_TRACK  A track. KTYPE_GROUP  A Group. KTYPE_IMPLY  A implication constraint (a selection constraint). KTYPE_EQUIV  An equivalence constraint (a mixing constraint). KTYPE_EXCLU  An exclusion constraint (a selection constraint). KTYPE_NOTMUTE  A not-mute constraint (a selection constraint). KTYPE_ERROR  An error type.

---

Function Documentation

KL_API KBool k_addTrackWithFilePath (  KFile *  pKFile, KCString  sTrackName, const KUInt32  iDate, KCString  sFileName )

Adds a track with an associated audio file in a KFile structure. Parameters: pKFile  the pointer to the KFile structure sTrackName  the track name iDate  the start date of the given track in samples sFileName  the name of the file to be associated Returns: ktrue if successful otherwise kfalse

KL_API KBool k_deleteElt (  KFile *  pKFile, KCString  sEltName )

Deletes a element from a KFile structure. Parameters: pKFile  a pointer to a valid KFile structure sEltName  the element name to delete Returns: ktrue if successful otherwise kfalse

KL_API KBool k_renameElt (  KFile *  pKFile, KCString  sOldName, KCString  sNewName )

Renames an element in a KFile structure. Parameters: pKFile  the pointer to the KFile structure sOldName  the name of the element to rename sNewName  the new element name Returns: ktrue if successful otherwise kfalse

KL_API KColor kelt_getColor (  KFile *  pKFile, KCString  sEltName )

Gets the color of an element. Parameters: pKFile  a pointer to a valid KFile structure sEltName  an element name Returns: the element color

KL_API KEltType kelt_getType (  KFile *  pKFile, KCString  sEltName )

Gets the type of an element in a KFile structure. Parameters: pKFile  the pointer to the KFile structure sEltName  an element name Returns: the element type

KL_API KBool kelt_hideElt (  KFile *  pKFile, KCString  sEltName )

Hides an element. Parameters: pKFile  the pointer to the KFile structure sEltName  the element name Returns: ktrue if successful otherwise kfalse

KL_API KBool kelt_setColor (  KFile *  pKFile, KCString  sEltName, KColor  iColor )

Sets a color to an element. Parameters: pKFile  a pointer to a valid KFile structure sEltName  an element name iColor  a KColor value Returns: ktrue if successful otherwise kfalse See also: KColor type in KToolLib.

KL_API KBool kelt_setDefaultLevel (  KFile *  pKFile, KCString  sEltName, KLevel  dLevel )

Sets the default level of an element. Parameters: pKFile  a pointer to a valid KFile structure sEltName  an element name dLevel  a KLevel value Returns: ktrue if successful otherwise kfalse

KL_API KBool kelt_showElt (  KFile *  pKFile, KCString  sEltName )

Shows an element. Parameters: pKFile  the pointer to the KFile structure sEltName  the element name Returns: ktrue if successful otherwise kfalse

---