DD::Image::StringKnobI Class Reference

interface class for an array of characters or a string. More...

#include <StringKnobI.h>

Inheritance diagram for DD::Image::StringKnobI:

Public Types
typedef void()	CursorPositionChangedCallback(Knob *knob, int position, int selectionStart, int selectionEnd)
	callback for when the cursor position changes

Public Member Functions
virtual void	setCursorPosition (int newPosition, bool moveAnchor)=0
	set the cursor to the absolute position and optionally move the anchor also
virtual void	registerCursorChangedCallback (CursorPositionChangedCallback *cb)=0
	register a callback object to be called when the cursor position changes
virtual Knob *	baseKnob ()=0
	Return the Knob this interface is on. Implementations should just "return this;".
virtual void	default_value (const char *s, bool store=false)=0
virtual const char *	get_text (const OutputContext *context, bool evaluate=true) const =0
Public Member Functions inherited from DD::Image::ValueProvidableI
virtual void	setValueProvider (ValueProvider *valueProvider, bool enabled=true)=0
virtual void	enableValueProvider (bool enable=true)=0
virtual bool	isValueProviderEnabled () const =0
	Returns true if the value provider is assigned and globally enabled.
virtual int	getValueProviderMode () const =0
	Returns the value provider mode (<=0 means disable, 1 or above means enabled when not overriden by authoring)
virtual ValueProvider *	getValueProvider () const =0
	Returns the assigned ValueProvider, or nullptr if none is assigned.

Static Public Attributes
static const int	kNoSelection

Detailed Description

interface class for an array of characters or a string.

Member Function Documentation

default_value()

virtual void DD::Image::StringKnobI::default_value ( const char *  s, bool  store = false  )

pure virtual

Sets the default value for the StringKnob. If store is true then the string content is copied locally into the StringKnob, otherwise the calling object retains ownership of the string buffer.

get_text()

virtual const char * DD::Image::StringKnobI::get_text ( const OutputContext *  context, bool  evaluate = true  ) const

pure virtual

evaluate only valid for EvalStringKnob subclasses. Returns a non-evaluated (raw) string if evaluate is false.

Referenced by DD::Image::CameraSceneOp::projectionFuncClassName().