i_Option.h File Reference

Description

This file contains type definitions used in IConnectIDE3::Option() method.

#include <stdint.h>

Macros
#define	OPTION_URL_DestIDE   "IDE"
	Example for using data creation. More...

Enumerations
enum	EOptionFlags : uint32_t {   ofValNone = 0x00000000 , ofValString = 0x00000001 ,   ofValInt = 0x00000002 , ofValFloat = 0x00000003 ,   ofValStringInt = 0x00000004 , ofValBuffer = 0x0000000E ,   ofValNode = 0x0000000F , ofValMask = 0x0000000F ,   ofDestIDE = 0x00000000 , ofDestDocument = 0x00000010 ,   ofDestIOPEN = 0x00000020 , ofDestPlugin = 0x00000030 ,   ofDestAuto = 0x000000F0 , ofDestMask = 0x000000F0 ,   ofSet = 0x00000000 , ofGet = 0x80000000 ,   ofAdd = 0x01000000 , ofRemove = 0x02000000 ,   ofGetSize = 0x03000000 , ofCall = 0x04000000 ,   ofGetType = 0x05000000 , ofGetEnum = 0x06000000 ,   ofMask = 0x8F000000 , ofCommit = 0x40000000 ,   ofGetDescriptor = 0x20000000 , ofGetMenu = 0x00400000 ,   ofGetObjectMask = 0x20400000 , ofUseDescriptor = 0x00800000 ,   ofReservedBit0 = 0x00100000 , ofReservedBit1 = 0x00200000 ,   ofReservedMask = 0x00300000 , ofExact = 0x10000000 }
	Flags for IConnectIDE3::Option() method. More...

Macro Definition Documentation

OPTION_URL_DestIDE

#define OPTION_URL_DestIDE   "IDE"

Example for using data creation.

SOptionValue OV; SVariantData_SetSize_ZeroInit(OV); // create a copy of data for "Analyzer Setup" LPCSTR pszDataName = "Analyzer Setup"; pIXXX->Option(ofDataCreate | ofGetDescriptor, pszDataName, &OV); // remember descriptor IDescriptor * pID = OV.m_pIDescriptor;

// manipulate data // ensure descriptor from copy of data OV.m_pIDescriptor = pID; pIXXX->Option(ofUseDescriptor | ofSet | ofValInt, "...", &OV); ...

// release descriptor pID->Release();

// apply data pIXXX->Option(ofDataApply, pszDataName, &OV);

// discard data pIXXX->Option(ofDataDestroy, pszDataName, &OV);

Enumeration Type Documentation

EOptionFlags

enum EOptionFlags : uint32_t

Flags for IConnectIDE3::Option() method.

Enumerator
ofValNone	operation other than set or get is performed
ofValString	single option, string type value
ofValInt	single option, integer type value
ofValFloat	single option, float type value
ofValStringInt	single option, string type, but string is int encoded for int types. No enum or TRUE/FALSE are used
ofValBuffer	all options. pszOption not used, pszString is source/destination
ofValNode	all options. pszOption is URL to the data node to be ser-des'd. JSON encode
ofDestIDE	destination is the global IDE
ofDestDocument	destination is a document
ofDestIOPEN	destination is isystem.open plugin
ofDestPlugin	destination is isystem.plugin plugin
ofDestAuto	destination is decoded from first /<dest>/ item
ofDestMask	destination mask
ofSet	set the option
ofGet	retrieve the option
ofAdd	Add an item to a dynamic data, at index SOptionValue.m_dwInteger (-1 for append)
ofRemove	remove an item from dynamic data, at index SOptionValue.m_dwInteger (-1 to remove all)
ofGetSize	return size of static or dynamic array in SOptionValue.m_dwInteger
ofCall	pszOption specifies the function path, SOptionValue.m_pszStringIn the input parameters, SOptionValue.m_pszStringOut the output parameters in/out parameters are encoded as a sequence of <name1>:<value1>, .., <nameN>:<valueN>
ofGetType	return type of container (IDataDescriptor::EContainer) in SOptionValue.m_dwInteger
ofGetEnum	return enum values in SOptionValue.m_pszStringOut, format "<name1>":<value1>, .., "<nameN>":<valueN>> SOptionValue.m_dwInteger will be set to 1 if the URL is an enum, 0 otherwise
ofMask	mask to extract set/get/add/remove option
ofCommit	commit the options configured - this should be the ultimate call after a one or more ofSet calls. This flag should be ORed wit hone of ofDest... flags. Parameters pszScope and pszOption of IConnectIDE3::Option() may be NULL, while pValue should be initialized to 0, except out buffer, which receives error description in case of error.
ofGetDescriptor	get the data descriptor. returned in SOptionValue.m_pIDescriptor
ofGetMenu	get the menu structure
ofGetObjectMask	mask for getting objects (descriptor, menu)
ofUseDescriptor	use the SOptionValue.m_pIDescriptor on input
ofReservedMask	mask for reserved bits which can be used for internal purpose
ofExact	set this option exactly - no side effects (adjusting other options) should take place