VkModifiedAttachment(3x)VkModifiedAttachment(3x)NAMEVkModifiedAttachment - Attachment class for showing modified text widgets
INHERITS FROM
VkModified :
HEADER FILE
#include <Vk/VkModified.h>
PUBLIC PROTOCOL SUMMARY
Constructor/Destructor
VkModifiedAttachment(Boolean blankIsValue = False,
Boolean autoAdjust = True,
Boolean incrementalChange = False);
virtual void ~VkModifiedAttachment(void);
Configuration
virtual void setParameters(Dimension width,
Dimension height);
void getParameters(Dimension* width, Dimension* height);
void attach(Widget w);
void detach(void);
void adjustGeometry(void);
Access Functions
Widget widget(void);
Display Functions
void show(void);
void hide(void);
void expose(void);
void displayValue(void);
X RESOURCES ASSOCIATED WITH THIS CLASS
displayModified Whether to display the visual indicator (True)
CLASS DESCRIPTION
The VkModifiedAttachment class is an attachment rather than a component.
You use the attach method to attach it to an existing text widget, and
then call the show method to make it visible. Once visible,
VkModifiedAttachment will automatically display a "folded-corner" in the
upper-right of the text widget when the user changes the text value. The
user can flip between previous and current text values by clicking in the
corner area.
Page 1
VkModifiedAttachment(3x)VkModifiedAttachment(3x)FUNCTION DESCRIPTIONSVkModifiedAttachment()
VkModifiedAttachment(Boolean blankIsValue = False,
Boolean autoAdjust = True,
Boolean incrementalChange = False);
virtual void ~VkModifiedAttachment(void);
The VkModifiedAttachment constructor creates an object capable of
attaching to a text widget and displaying modified-state information
to the user. The user can click on the attachment area (the upper-
left corner) to alternate between previous and current text values.
The first argument defaults to False and indicates whether a blank
(empty string) is considered a valid previous value when displaying
the folded corner. The second argument defaults to True and
indicates whether VkModifiedAttachment automatically watches the
attached text widget for geometry changes and adjusts its own area
accordingly. The last argument defaults to False and indicates
whether incremental character changes should trigger changes in the
display.
setParameters()
virtual void setParameters(Dimension width,
Dimension height);
Adjusts VkModifiedAttachment display parameters. The first is the
width of the attachment area, the second is the height.
getParameters()
void getParameters(Dimension* width, Dimension* height);
Returns VkModifiedAttachment display parameters. The first is the
width of the attachment area, the second is the height.
widget()
Widget widget(void);
Returns the widget current attached to by the VkModifiedAttachment
object.
attach()
void attach(Widget w);
Page 2
VkModifiedAttachment(3x)VkModifiedAttachment(3x)
Attaches to a widget. If already attached, first detaches from the
old widget.
detach()
void detach(void);
Detaches from the current widget. The attachment area, if visible,
is removed.
show()
void show(void);
Turn on display of the attachment area. If the previous value
differs from the current value, a folder corner is displayed. This
method has no effect if the "displayModified" resource is explicitly
set to False.
hide()
void hide(void);
Turns off display of the attachment area.
expose()
void expose(void);
Force redrawing of the attachment area. This gets called
automatically when Expose events are received.
displayValue()
void displayValue(void);
Change the text widget value to the last activated-value.
adjustGeometry()
void adjustGeometry(void);
Force VkModifiedAttachment to reconfigure itself. Applications
should call this after they change the geometry of the text widget,
unless autoAdjust is set to True.
modifiedCallback
static const const char* modifiedCallback;
Page 3
VkModifiedAttachment(3x)VkModifiedAttachment(3x)
A callback function for detecting activation of the attached text
widget, or a value change in the text widget. Use this callback
instead of installing your own XmNactivate or XmNvalueChanged
callbacks. The callData argument should be cast to a (VkModified
*).
INHERITED MEMBER FUNCTIONS
Inherited from VkModified
VkModified(), ~VkModified(), blankIsValue(), autoAdjust(),
modified(), latestDisplay(), value(), previousValue(),
updateModified(), _modified, _latest, _width, _height, _value,
_previousValue, _blankIsValue, _autoAdjust, _fixedPrevious,
KNOWN CLASSES THAT USE THIS CLASSVkModifiedAttachmentSEE ALSO
VkModified, VkModifiedAttachment,
ViewKit Programmer's Guide
The X Window System, DEC Press, Bob Sheifler and Jim Gettys
The X Window System Toolkit, DEC Press, Paul Asente and Ralph Swick
The OSF/Motif Programmers Reference, Prentice Hall, OSF
Page 4
