:: com :: sun :: star :: awt ::
|
unpublished |
service UnoControlRoadmapModel |
|
|
- Usage Restrictions
- not published
- Description
- specifies the standard model of an UnoControlContainer.
|
Included Services - Summary |
UnoControlModel |
- (referenced entity's summary:)
- specifies the standard model of an UnoControl
in the Smalltalk model view controller design.
|
Exported Interfaces - Summary |
::com::sun::star::container::XIndexContainer |
The control serves as an indexed container typically for RoadmapItems
as specified in com::sun::star::awt:RoadmapItem. The RoadmapItems are
held in a sequence.
When inserting such items their ID is set equal to the Index of their
insertion by default.
After removing items the CurrentItem property is - when beyound the upper sequence
boundaries - set equal to last index of the RoadmapItem Array.
|
Properties' Summary |
long
BackgroundColor |
specifies the background color (RGB) of the control.
The Default value is white
|
boolean
Interactive |
determines whether the control is interactive or not.
|
boolean
Complete |
determines whether the control container is complete or not. If it is
false than a non - interactive RoadmapItem is appended
|
string
ImageURL |
specifies an URL to an image to use for the control.
The image is placed in the lower right corner of the control
|
[ transient ] ::com::sun::star::graphic::XGraphic
Graphic |
[ OPTIONAL ]
specifies a graphic to be displayed on the control
|
short
Border |
specifies the border style of the control.
|
boolean
Printable |
specifies whether the control will be printed with the document.
|
string
Text |
specifies the text displayed in the control.
|
short
CurrentItemID |
refers to the ID of the currently selected item. Initially this property is set to '-1'
which is equal to 'undefined"
If the Roadmap Item that the CurrentItemID refers to is removed the property
'CurrentItemID' is set to -1
|
string
HelpText |
specifies the help text of the control.
|
string
HelpURL |
specifies the help URL of the control.
|
Included Services - Details |
UnoControlModel
- (referenced entity's summary:)
- specifies the standard model of an UnoControl
in the Smalltalk model view controller design.
|
|
Exported Interfaces - Details |
::com::sun::star::container::XIndexContainer
- Description
- The control serves as an indexed container typically for RoadmapItems
as specified in com::sun::star::awt:RoadmapItem. The RoadmapItems are
held in a sequence.
When inserting such items their ID is set equal to the Index of their
insertion by default.
After removing items the CurrentItem property is - when beyound the upper sequence
boundaries - set equal to last index of the RoadmapItem Array.
|
|
Properties' Details |
BackgroundColor
long BackgroundColor;
- Description
- specifies the background color (RGB) of the control.
The Default value is white
|
|
Interactive
boolean Interactive;
- Description
- determines whether the control is interactive or not.
A roadmap control which is interactive allows selecting its items out-of-order,
by simply clicking them.
|
|
Complete
boolean Complete;
- Description
- determines whether the control container is complete or not. If it is
false than a non - interactive RoadmapItem is appended
|
|
ImageURL
string ImageURL;
- Description
- specifies an URL to an image to use for the control.
The image is placed in the lower right corner of the control
- See also
- Graphic
|
|
Graphic
[ transient ] ::com::sun::star::graphic::XGraphic Graphic;
- Usage Restrictions
- optional
- Description
- specifies a graphic to be displayed on the control
If this property is present, it interacts with the ImageURLin the
following way:
- If ImageURL is set, Graphic will be reset
to an object as loaded from the given image URL, or NULL if ImageURL
does not point to a valid image file.
- If Graphic is set, ImageURL will be reset
to an empty string.
- Since
- OOo 2.1
|
|
Border
short Border;
- Description
- specifies the border style of the control.
0: No border
1: 3D border
2: simple border
|
|
Printable
boolean Printable;
- Description
- specifies whether the control will be printed with the document.
|
|
Text
string Text;
- Description
- specifies the text displayed in the control.
|
|
CurrentItemID
short CurrentItemID;
- Description
- refers to the ID of the currently selected item. Initially this property is set to '-1'
which is equal to 'undefined"
If the Roadmap Item that the CurrentItemID refers to is removed the property
'CurrentItemID' is set to -1
|
|
HelpText
string HelpText;
- Description
- specifies the help text of the control.
|
|
HelpURL
string HelpURL;
- Description
- specifies the help URL of the control.
|
|
Top of Page
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.