rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvPathGadgetItem Class Reference

Gadget item class with a pathname. More...

#include <ilviews/gadgets/filechoo.h>

Inheritance diagram for IlvPathGadgetItem:
IlvGadgetItem

List of all members.

Public Member Functions

 IlvPathGadgetItem (const char *label, IlvGraphic *graphic, IlvPosition position=IlvDefaultGadgetItemPosition, IlUShort spacing=IlvDefaultGadgetItemSpacing, IlBoolean copy=IlTrue)
 Constructor.
 IlvPathGadgetItem (const char *label, IlvBitmap *bitmap=0, IlvPosition position=IlvDefaultGadgetItemPosition, IlUShort spacing=IlvDefaultGadgetItemSpacing, IlBoolean copy=IlTrue)
 Constructor.
const IlPathNamegetPathName () const
 Returns the path.
void setPathName (const IlPathName &path)
 Sets the path.

Detailed Description

Gadget item class with a pathname.

Library: ilvadvgdt

This gadget item class is used by the IlvFileChooserSheet objects to store a path for each item of the sheet.

See also:
IlvFileChooserSheet, IlvGadgetItem

Constructor & Destructor Documentation

IlvPathGadgetItem::IlvPathGadgetItem ( const char *  label,
IlvBitmap bitmap = 0,
IlvPosition  position = IlvDefaultGadgetItemPosition,
IlUShort  spacing = IlvDefaultGadgetItemSpacing,
IlBoolean  copy = IlTrue 
)

Constructor.

Initializes a new instance of the IlvPathGadgetItem class. This constructor allows you to specify both a label and a bitmap, as well as their relative alignment and spacing. The bitmap is locked.

Parameters:
label The item label.
bitmap The item sensitive bitmap.
position The label position relative to the picture.
spacing The spacing between the label and the picture.
copy A Boolean value specifying whether a label should be copied. If the value is IlFalse, then memory must be allocated for the label because the label characters are deleted from memory by the IlvPathGadgetItem.
IlvPathGadgetItem::IlvPathGadgetItem ( const char *  label,
IlvGraphic graphic,
IlvPosition  position = IlvDefaultGadgetItemPosition,
IlUShort  spacing = IlvDefaultGadgetItemSpacing,
IlBoolean  copy = IlTrue 
)

Constructor.

Initializes a new instance of the IlvPathGadgetItem class. This constructor allows you to specify both a label and a graphic, as well as their relative alignment and spacing.

Parameters:
label The item label.
graphic The item picture.
position The label position relative to the picture.
spacing The spacing between the label and the picture.
copy A Boolean value specifying whether a label should be copied. If the value is IlFalse, then memory must be allocated for the label because the label characters are deleted from memory by the IlvPathGadgetItem.

Member Function Documentation

const IlPathName& IlvPathGadgetItem::getPathName (  )  const

Returns the path.

Returns:
The full path corresponding to the label of the gadget item.
void IlvPathGadgetItem::setPathName ( const IlPathName path  ) 

Sets the path.

Sets the full path corresponding to the label of the gadget item.

Parameters:
path The path.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.