GdkToolOutput.h

Go to the documentation of this file.

/**
* @file    GdkToolOutput.h
* @brief   Declares the GdkToolOutput class.
*
* Copyright (C) 2015 by LMI Technologies Inc.  All rights reserved.
*/
#ifndef GDK_TOOL_OUTPUT_H
#define GDK_TOOL_OUTPUT_H

#include <Gdk/GdkDef.h>
#include <Gdk/Data/GdkGraphic.h>

kBeginHeader()

/**
* Represents a tool output collection.
*
* @class       GdkToolOutput
* @extends     kObject
* @ingroup     Gdk-Tools
*/
typedef kObject GdkToolOutput;
kDeclareClass(Gdk, GdkToolOutput, kObject)
kDeclareValue(Gdk, GdkToolOutputItem, kValue)

/**
* Sets the measurement output at a specified index.
*
* @public               @memberof GdkToolOutput
* @param    output      Output object.
* @param    index       Measurement index within the tool.
* @param    value       Output value.
* @param    decision    Output decision.
* @return               Operation status.
*/
GdkFx(kStatus) GdkToolOutput_SetResult(GdkToolOutput output, kSize index, k64f value, GdkMeasurementDecision decision);

/**
* Sets the measurement rendering at a specified index.
*
* @public               @memberof GdkToolOutput
* @param    output      Output object.
* @param    index       Measurement index within the tool.
* @param    graphic     GdkGraphic object (ownership is transferred).
* @return               Operation status.
*/
GdkFx(kStatus) GdkToolOutput_SetRendering(GdkToolOutput output, kSize index, GdkGraphic graphic);

kEndHeader()

#endif