You may return to the Cvo Object Documenation Index from this document. This document contains the following sections describing the Cvo_PinUp object:
Cvo_PinUp
Cvo_Window
#include
<Cvo/PinUp.h++>
new
Cvo_PinUp ( char *resource_name,
[ Cvo_Object *parent | Display *display ],
[ char *title ] )
A Cvo_PinUp object is a window with a push pin and a title. If the title argument is given it is used as the title for the pinup window. If no parent or display arguments are passed, it is created on the default display. When the user pulls the push pin out, the object will be destroyed.
This object defines the following member functions in addition to those defined by its parent and ancestor objects.
void Used (
)
Inform the Cvo_PinUp object that it has been used. If the pin is not currently pressed in, the Cvo_PinUp object will be destroyed.
void Pinned (
[ BOOL value ] )
Cause the pin in the Cvo_PinUp object to be pressed in (or not pressed in if value is passed as False). This allows a Cvo_PinUp object to be started with the pin pressed in. This is useful for display Cvo_PinUp objects as opposed to dialog Cvo_PinUp objects.
void SetText (
char *title )
Set the title of the Cvo_PinUp object window.
This object is composed of the following Cvo objects. Each object has the shown resource name. This link displays the composition of the parent object.
Cvo_Frame
:
*CvoPinUp.title_frame
Cvo_Pin
:
*CvoPinUp.title_frame.pin
Cvo_Label
:
*CvoPinUp.title_frame.title
See the example source code for an example of how to use this object.
See the legend for information about the conventions used in this documentation.