rvclegnd.h File Reference

<mi32/rvclegnd.h> Definitions for RVC LEGEND object structures More...

#include <mi32/rvcdefns.h>

Include dependency graph for rvclegnd.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	RVCLEGENDINFO
	Legend Header. More...
struct	RVCLEGENDLINE
	All list entries in a legend object are a series of UWORDs This structure is used in-memory only. More...
struct	RVCLEGENDTEXTSTYLE
	Legend text style structure. More...
Defines
#define	LEGENDFLAG_DescDQuery   0x08
#define	LEGENDFLAG_DescFromField   0x02
#define	LEGENDFLAG_DescFromTheme   0x10
#define	LEGENDFLAG_DescQuery   0x04
#define	LEGENDFLAG_Selected   0x01
Functions
int	MfCloseLegend (int id, RVCLEGENDINFO *info)
void	MfFreeLegendLine (RVCLEGENDLINE *llp)
int	MfMakeLegend (int fid, RVCLEGENDINFO *info, UINT32 flags)
int	MfOpenLegend (int fid, INT32 inode, RVCLEGENDINFO *info, UINT32 flags)
int	MfReadLegend (int id, INT32 num, RVCLEGENDLINE *inllp)
RVCAPPLIBEXPORT int	MfReadLegendBuf (int id, INT32 num, void *buf)
int	MfReadLegendHeader (int fhandle, RVCINODENUM inode, RVCLEGENDINFO *info)
int	MfWriteLegend (int id, INT32 num, RVCLEGENDLINE *inllp)
RVCAPPLIBEXPORT int	MfWriteLegendBuf (int id, INT32 num, INT32 size, const void *buf)
int	MfWriteLegendHeader (int fhandle, RVCINODENUM inode, RVCLEGENDINFO *info)

---

Detailed Description

<mi32/rvclegnd.h> Definitions for RVC LEGEND object structures

Definition in file rvclegnd.h.

---

Define Documentation

#define LEGENDFLAG_DescDQuery   0x08

Get description from default query. Definition at line 135 of file rvclegnd.h.

#define LEGENDFLAG_DescFromField   0x02

Description just gives table.field. Definition at line 133 of file rvclegnd.h.

#define LEGENDFLAG_DescFromTheme   0x10

Get description from a theme. Definition at line 136 of file rvclegnd.h.

#define LEGENDFLAG_DescQuery   0x04

Description is a string query. Definition at line 134 of file rvclegnd.h.

#define LEGENDFLAG_Selected   0x01

Draw an entry for this style. Definition at line 132 of file rvclegnd.h.

---

Function Documentation

int MfCloseLegend (  int  id, RVCLEGENDINFO *  info )  [inline]

Close a legend. Parameters: id  Legend object handle info  Legend object to close Definition at line 222 of file rvclegnd.h.

void MfFreeLegendLine (  RVCLEGENDLINE *  llp  )  [inline]

Free a legend. Parameters: llp  Legend line structure to free Definition at line 267 of file rvclegnd.h.

int MfMakeLegend (  int  fid, RVCLEGENDINFO *  info, UINT32  flags )  [inline]

Make a legend. Parameters: fid  Open file handle info  Legend structure passed / returned flags  Flags Definition at line 230 of file rvclegnd.h.

int MfOpenLegend (  int  fid, INT32  inode, RVCLEGENDINFO *  info, UINT32  flags )  [inline]

Open a legend. Parameters: fid  Open file handle inode  Legend object inode info  Legend structure passed / returned flags  Flags Definition at line 239 of file rvclegnd.h.

int MfReadLegend (  int  id, INT32  num, RVCLEGENDLINE *  inllp )  [inline]

Read a legend. Parameters: id  Legend object handle num  Item number inllp  Legend line structure returned Definition at line 249 of file rvclegnd.h.

RVCAPPLIBEXPORT int MfReadLegendBuf (  int  id, INT32  num, void *  buf )

Legend functions< GENERATING_DOXYGEN_OUTPUT Read a legend into a buffer. Parameters: id  Legend object handle num  Item number buf  Buffer to read to

int MfReadLegendHeader (  int  fhandle, RVCINODENUM  inode, RVCLEGENDINFO *  info )  [inline]

Read legend header. Parameters: fhandle  Open file handle inode  Legend object inode info  Legend header passed / returned Definition at line 139 of file rvclegnd.h.

int MfWriteLegend (  int  id, INT32  num, RVCLEGENDLINE *  inllp )  [inline]

Write a legend. Parameters: id  Legend object handle num  Item number inllp  Legend line structure to write from Definition at line 258 of file rvclegnd.h.

RVCAPPLIBEXPORT int MfWriteLegendBuf (  int  id, INT32  num, INT32  size, const void *  buf )

Write a legend from a buffer. Parameters: id  Legend object handle num  Item number size  Size of buffer buf  Buffer to write from

int MfWriteLegendHeader (  int  fhandle, RVCINODENUM  inode, RVCLEGENDINFO *  info )  [inline]

Write legend header. Parameters: fhandle  Open file handle inode  Legend object inode info  Legend header to write Definition at line 148 of file rvclegnd.h.

---