HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HUSD_BucketValue Class Reference

#include <HUSD_Bucket.h>

Public Member Functions

void setKeyword (const UT_StringRef &keyword)
 Sets and gets the keyword (a string). More...
 
const UT_StringHoldergetKeyword () const
 Sets and gets the keyword (a string). More...
 
void setOptions (const UT_Options &options)
 Sets and gets the options (ie, parameters and their values). More...
 
const UT_OptionsgetOptions () const
 Sets and gets the options (ie, parameters and their values). More...
 

Detailed Description

Represents a value associated with the bucket Note, the keyword could be part of options structure, but many situations benefit from having a single default bucketing string, such as a keyword.

Definition at line 29 of file HUSD_Bucket.h.

Member Function Documentation

const UT_StringHolder& HUSD_BucketValue::getKeyword ( ) const
inline

Sets and gets the keyword (a string).

Definition at line 35 of file HUSD_Bucket.h.

const UT_Options& HUSD_BucketValue::getOptions ( ) const
inline

Sets and gets the options (ie, parameters and their values).

Definition at line 42 of file HUSD_Bucket.h.

void HUSD_BucketValue::setKeyword ( const UT_StringRef keyword)
inline

Sets and gets the keyword (a string).

Definition at line 33 of file HUSD_Bucket.h.

void HUSD_BucketValue::setOptions ( const UT_Options options)
inline

Sets and gets the options (ie, parameters and their values).

Definition at line 40 of file HUSD_Bucket.h.


The documentation for this class was generated from the following file: