INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "Contains information about character formatting in a ", "rich edit control. ", "WEL: library of reusable components for Eiffel. ", "Based on WEL library for ISE Eiffel, used with permission. "
project: "Windows Eiffel Library"
copyright: "(c) 1986-1997 Interactive Software Engineering Inc. ", "Modifications and extensions: ", "(c) 1997-2001 Object Tools ", "All rights reserved. Duplication and distribution prohibited", "May be used only with Visual Eiffel under terms of user ", "license "
cluster: wel
class WEL_CHARACTER_FORMAT
inherit

WEL_STRUCTURE
rename
make as structure_make
end

WEL_CFM_CONSTANTS
export
{NONE}
all
end

WEL_CFE_CONSTANTS
export
{NONE}
all
end

WEL_BIT_OPERATIONS
export
{NONE}
all
end
creation

make,
make_by_pointer
feature {NONE}-- Initialization

make
-- Make a char format structure.
feature -- Access

char_set: INTEGER
-- Character set value. Can be one of the values
-- specified for the `char_set' function of the
-- WEL_LOG_FONT structure.

face_name: STRING
-- Font face name
ensure
result_not_void: Result /= void

height: INTEGER
-- Character height

offset: INTEGER
-- Character offset from the baseline. If the value
-- is positive, the character is a superscript; if it
-- is negative, the character is a subscript.

pitch_and_family: INTEGER
-- Font pitch and family. This value is the same as
-- `pitch_and_family' of the WEL_LOG_FONT structure.

text_color: WEL_COLOR_REF
-- Text color
ensure
result_not_void: Result /= void

Max_face_name_length: INTEGER
-- Maximum face name length

mask: INTEGER
-- Valid information or attributes to set.
-- See class WEL_CFM_CONSTANTS for values.
-- This attribut is automatically set by the
-- features set_*.

effects: INTEGER
-- Character effects.
-- See class WEL_CFE_CONSTANTS for values.
feature -- Element change

set_char_set (a_char_set: INTEGER)
-- Set `char_set' with `a_char_set'.
ensure
char_set_set: char_set = a_char_set

set_face_name (a_face_name: STRING)
-- Set `face_name' with `a_face_name'.
require
a_face_name_not_void: a_face_name /= void
valid_count: a_face_name.count <= max_face_name_length
ensure
face_name_set: face_name.is_equal (a_face_name)

set_height (a_height: INTEGER)
-- Set `height' with `a_height'.
ensure
height_set: height = a_height

set_offset (an_offset: INTEGER)
-- Set `offset' with `an_offset'.
ensure
offset_set: offset = an_offset

set_pitch_and_family (a_pitch_and_family: INTEGER)
-- Set `pitch_and_family' with `a_pitch_and_family'.
ensure
pitch_and_family_set: pitch_and_family = a_pitch_and_family

set_text_color (a_color: WEL_COLOR_REF)
-- Set `text_color' with `a_text_color'.
ensure
text_color_set: text_color.is_equal (a_color)

set_bold
-- Set bold characters.

unset_bold
-- Unset bold characters.

set_italic
-- Set italic characters.

unset_italic
-- Unset italic characters.

set_strike_out
-- Set strike out characters.

unset_strike_out
-- Unset strike out characters.

set_underline
-- Set underline characters.

unset_underline
-- Unset underline characters.

set_protected
-- Set protected characters.

unset_protected
-- Unset protected characters.

set_mask (a_mask: INTEGER)
-- Set `mask' with `a_mask'.
-- See class WEL_CFM_CONSTANTS for `a_mask' values.
ensure
mask_set: mask = a_mask

add_mask (a_mask: INTEGER)
-- Add `a_mask' to `mask'.
-- See class WEL_CFM_CONSTANTS for `a_mask' values.
ensure
has_mask: has_mask (a_mask)

remove_mask (a_mask: INTEGER)
-- Remove `a_mask' from `mask'.
-- See class WEL_CFM_CONSTANTS for `a_mask' values.
ensure
has_not_mask: not has_mask (a_mask)

set_effects (an_effects: INTEGER)
-- Set `effects' with `an_effects'.
-- See class WEL_CFE_CONSTANTS for `a_mask' values.
ensure
effects_set: effects = an_effects

add_effects (an_effects: INTEGER)
-- Add `an_effects' to `effects'.
-- See class WEL_CFE_CONSTANTS for `a_mask' values.
ensure
has_effects: has_effects (an_effects)

remove_effects (an_effects: INTEGER)
-- Remove `an_effects' from `effects'.
-- See class WEL_CFE_CONSTANTS for `a_mask' values.
ensure
has_not_effects: not has_effects (an_effects)

set_all_masks
-- Set `mask' with all possible values.
feature -- Status report

has_mask (a_mask: INTEGER): BOOLEAN
-- Is `a_mask' set in `mask'?
-- See class WEL_CFM_CONSTANTS for `a_mask' values.

has_effects (an_effects: INTEGER): BOOLEAN
-- Is `an_effects' set in `effects'?
-- See class WEL_CFE_CONSTANTS for `an_effects' values.
feature -- Measurement

structure_size: INTEGER
-- Size to allocate (in bytes)
end -- class WEL_CHARACTER_FORMAT

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES