k_interaction.h File Reference

All functions for user interaction. More...

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

Functions
KL_API KStrList *	k_changeEltStatus (KFile *file, KCString trackName)
	Changes the status of the given track.
KL_API KBool	k_setAllStatusStop (KFile *file)
	Sets the stop status of all the elements of a KFile structure.
KL_API KBool	k_checkEltStatus (KFile *kfile)
	Verifies the status of all the elements of a KFile structure.
KL_API KBool	k_initializeStatus (KFile *kfile)
	Initializes the element status according to the current mix of the KFile structure.
KL_API KStrList *	k_moveLevel (KFile *pFile, KCString sName, KLevel dLevel)
	Moves a level of an element.
KL_API KBool	k_initializeLevel (KFile *file)
	Initializes the volumes of an iKlax file.
KL_API KBool	k_checkEltLevel (KFile *kfile)
	Verifies the volume levels of all the elements of a KFile structure.
KL_API KBool	k_saveCurentMix (KFile *pKFile, KCString sName)
	Saves the current mix of a KFile structure.
KL_API KBool	k_randomMix (KFile *file)
	Choices a random mix.
KL_API KStrList *	k_getMixNames (KFile *file)
	Gets the mix names of an iKlax file.
KL_API KBool	k_setMixAsCurrent (KFile *file, KCString sMixName)
	Sets a mix as current.
KL_API KCString	k_getDefaultMixName (KFile *pKFile)
	Gets the default mix of a KFile structure.

---

Detailed Description

All functions for user interaction.

Version:

iKlaxLib-1.5

Author:

Fabien Gallot

Date:

26/11/2009

See also:

This file has been developed with KToolLib.

Note:

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

---

Function Documentation

KL_API KStrList* k_changeEltStatus (  KFile *  file, KCString  trackName )

Changes the status of the given track. Verifies that this change is in concordance with the constraints Parameters: file  the pointer to the KFile structure trackName  the name of the track where status must be changed Returns: a list which contains all elements with moved status

KL_API KBool k_checkEltLevel (  KFile *  kfile  )

Verifies the volume levels of all the elements of a KFile structure. Parameters: kfile  the pointer to the KFile structure Returns: ktrue if the volume levels are correct otherwise kfalse

KL_API KBool k_checkEltStatus (  KFile *  kfile  )

Verifies the status of all the elements of a KFile structure. Parameters: kfile  the pointer to the KFile structure Returns: ktrue if the status of elements are correct otherwise kfalse

KL_API KCString k_getDefaultMixName (  KFile *  pKFile  )

Gets the default mix of a KFile structure. Parameters: pKFile  the pointer to the KFile structure Returns: the name of the default mix

KL_API KStrList* k_getMixNames (  KFile *  file  )

Gets the mix names of an iKlax file. Parameters: file  the pointer to the KFile structure Returns: a list which contains all mix names

KL_API KBool k_initializeLevel (  KFile *  file  )

Initializes the volumes of an iKlax file. Parameters: file  the pointer to the KFile structure Returns: ktrue if successful otherwise kfalse

KL_API KBool k_initializeStatus (  KFile *  kfile  )

Initializes the element status according to the current mix of the KFile structure. Parameters: kfile  the pointer to the KFile structure Returns: ktrue if successful otherwise kfalse

KL_API KStrList* k_moveLevel (  KFile *  pFile, KCString  sName, KLevel  dLevel )

Moves a level of an element. Checks constraints if possible, else return knull Parameters: pFile  the pointer to the KFile structure sName  the name of the element to move dLevel  the new level between 0.0 and 4.0 Returns: the list of element name with a new level

KL_API KBool k_randomMix (  KFile *  file  )

Choices a random mix. Changes the status of a random number of elements in a KFile structure and its levels. Parameters: file  the pointer to the KFile structure Returns: ktrue if successful otherwise kfalse

KL_API KBool k_saveCurentMix (  KFile *  pKFile, KCString  sName )

Saves the current mix of a KFile structure. Parameters: pKFile  the pointer to the KFile structure sName  the name of the current mix to be saved Returns: ktrue if successful otherwise kfalse

KL_API KBool k_setAllStatusStop (  KFile *  file  )

Sets the stop status of all the elements of a KFile structure. Parameters: file  the pointer to the KFile structure Returns: ktrue if successful otherwise kfalse

KL_API KBool k_setMixAsCurrent (  KFile *  file, KCString  sMixName )

Sets a mix as current. Parameters: file  the pointer to the KFile structure sMixName  a mix name Returns: ktrue if successful otherwise kfalse

---