formZ SDK | 5.0 API Reference | Project | Window Manager
Description
Window ruler option parameters. Used for the "which" argument of fz_wind_get_rulr_parm_data and fz_wind_get_rulr_parm.
enum fz_wind_rulr_opts_parm_enum {
FZ_WIND_RULR_DISPLAY_TOP,
FZ_WIND_RULR_DISPLAY_LEFT,
FZ_WIND_RULR_DISPLAY_BOTTOM,
FZ_WIND_RULR_DISPLAY_RIGHT,
FZ_WIND_RULR_COORD_ABS,
FZ_WIND_RULR_REF_WORLD,
FZ_WIND_RULR_SHOW_TEXT,
FZ_WIND_RULR_SHOW_UNIT,
FZ_WIND_RULR_INCR_TYPE,
FZ_WIND_RULR_INCR_MOD_H,
FZ_WIND_RULR_INCR_MOD_V,
FZ_WIND_RULR_INCR_DIV_H,
FZ_WIND_RULR_INCR_DIV_V,
FZ_WIND_RULR_SUBDIV,
FZ_WIND_RULR_SUBDIV_H,
FZ_WIND_RULR_SUBDIV_V,
FZ_WIND_RULR_ORIGIN,
FZ_WIND_RULR_ORIGIN_H,
FZ_WIND_RULR_ORIGIN_V,
FZ_WIND_RULR_PLOT_SCALE };
Members
FZ_WIND_RULR_DISPLAY_TOP
Indicates the ruler is displayed on the top edge of the window.
Type: fzrt_boolean
Default Value: TRUE
FZ_WIND_RULR_DISPLAY_LEFT
Indicates the ruler is displayed on the left edge of the window.
Type: fzrt_boolean
Default Value: TRUE
FZ_WIND_RULR_DISPLAY_BOTTOM
Indicates the ruler is displayed on the bottom edge of the window.
Type: fzrt_boolean
Default Value: FALSE
FZ_WIND_RULR_DISPLAY_RIGHT
Indicates the ruler is displayed on the right edge of the window.
Type: fzrt_boolean
Default Value: FALSE
FZ_WIND_RULR_COORD_ABS
Indicates the ruler is in absolute coordinates.
If this is set, the origin of the rulers is aligned with the origin of the coordinate continuously.
Otherwise, relative coordinates are used which means the origin of the rulers is adjusted each time a new
point is drawn, and is aligned with the previous point.
Type: fzrt_boolean
Default Value: TRUE
FZ_WIND_RULR_REF_WORLD
Indicates the ruler is using the world coordinate as the base. If not set, the ruler uses the reference plane coordinate as the base.
Type: fzrt_boolean
Default Value: TRUE
FZ_WIND_RULR_SHOW_TEXT
Indicates the ruler will display text in the ruler. If FZ_WIND_RULR_SHOW_UNIT is set, numeric measurements and the units are displayed in the ruler, otherwise only the numeric measurements are displayed. If not set, no text is displayed in the rulers.
Type: fzrt_boolean
Default Value: TRUE
FZ_WIND_RULR_SHOW_UNIT
Indicates the ruler will display the unit indicators in the ruler. This option is only available if FZ_WIND_RULR_SHOW_TEXT is set. If not set, the unit indicators won't be displayed in the ruler.
Type: fzrt_boolean
Default Value: TRUE
FZ_WIND_RULR_INCR_TYPE
Indicates the ruler increment type.
Type: fz_wind_rulr_incr_opts_parm_enum
Default Value: FZ_WIND_RULR_INCR_GRID
FZ_WIND_RULR_INCR_MOD_H
Indicates the distance between major marks on the ruler in the horizontal direction. This is only valid if FZ_WIND_RULR_INCR_TYPE is set to FZ_WIND_RULR_INCR_SET.
Type: double
FZ_WIND_RULR_INCR_MOD_V
Indicates the distance between major marks on the ruler in the vertical direction. This is only valid if FZ_WIND_RULR_INCR_TYPE is set to FZ_WIND_RULR_INCR_SET.
Type: double
FZ_WIND_RULR_INCR_DIV_H
Indicates the number of divisions between major marks on the ruler in the horizontal direction. This is only valid if FZ_WIND_RULR_INCR_TYPE is set to FZ_WIND_RULR_INCR_SET.
Type: fzrt_int
Default Value: 4
Range: value >= 0
FZ_WIND_RULR_INCR_DIV_V
Indicates the number of divisions between major marks on the ruler in the vertical direction. This is only valid if FZ_WIND_RULR_INCR_TYPE is set to FZ_WIND_RULR_INCR_SET.
Type: fzrt_int
Default Value: 4
Range: value >= 0
FZ_WIND_RULR_SUBDIV
Indicates the ruler will be subdivided by the specified amount when larger window display scales are used. When this is set, subdivisions will be subdivided again and again, whenever the whole number of subdivisions in FZ_WIND_RULR_SUBDIV_H or FZ_WIND_RULR_SUBDIV_V fits in the space of the immediately higher level of subdivision. This is only valid if FZ_WIND_RULR_INCR_TYPE is set to FZ_WIND_RULR_INCR_SET or FZ_WIND_RULR_INCR_GRID.
Type: fzrt_boolean
Default Value: TRUE
FZ_WIND_RULR_SUBDIV_H
Indicates the number of subdivisions used in the horizontal ruler. This is only valid if FZ_WIND_RULR_INCR_TYPE is set to FZ_WIND_RULR_INCR_SET or FZ_WIND_RULR_INCR_GRID and FZ_WIND_RULR_SUBDIV is on.
Type: fzrt_int
Default Value: 2
Range: value >= 0
FZ_WIND_RULR_SUBDIV_V
Indicates the number of subdivisions used in the vertical ruler. This is only valid if FZ_WIND_RULR_INCR_TYPE is set to FZ_WIND_RULR_INCR_SET or FZ_WIND_RULR_INCR_GRID and FZ_WIND_RULR_SUBDIV is on.
Type: fzrt_int
Default Value: 2
Range: value >= 0
FZ_WIND_RULR_ORIGIN
Indicates the ruler will use offset values for the origin.
Type: fzrt_boolean
Default Value: FALSE
FZ_WIND_RULR_ORIGIN_H
Indicates the offset value for the origin in the horizontal direction.
Type: double
Default Value: 0.0
FZ_WIND_RULR_ORIGIN_V
Indicates the offset value for the origin in the vertical direction.
Type: double
Default Value: 0.0
FZ_WIND_RULR_PLOT_SCALE
Indicates the layout of the rulers is set according to the plot scale values in the 'Plot/Print Setup' dialog.
Type: fzrt_boolean
Default Value: FALSE
Availability
5.0.0.0
See Also
Defined in