Struct

IpuzClue

Description [src] 

struct IpuzClue {
  /* No available fields */
}

An opaque data type representing an individual clue in a puzzle. Clues are used by both IpuzCrossword and IpuzAcrostic puzzles.

Constructors

ipuz_clue_new

Returns a new IpuzClue.

Instance methods

ipuz_clue_append_coord

Appends a raw coord to the internal list of coords of clue.

ipuz_clue_clear_coords

Resets all the coords associated with clue.

ipuz_clue_contains_coord

Returns TRUE if clue contains coord in it’s list of coords.

ipuz_clue_dup

Makes a copy of clue.

ipuz_clue_ensure_enumeration

Ensures that an enumeration exists for clue.

ipuz_clue_equal

Compares two clues and returns TRUE if they are identical.

ipuz_clue_get_clue_text

Returns the clue text of clue.

ipuz_clue_get_coord

Sets coord to be the coord at index.

ipuz_clue_get_coords

Returns the raw coords that clue represents, in order.

ipuz_clue_get_direction

Returns the direction of clue.

ipuz_clue_get_enumeration

Returns the enumeration of clue.

ipuz_clue_get_first_coord

Sets coord to be the first coord of clue. If no coords have been set to clue, then coord is untouched and FALSE is returned.

ipuz_clue_get_label

Gets the text to display in the list of clues instead of the clue number.

ipuz_clue_get_location

Sets location to be the coord of clue.

ipuz_clue_get_n_coords

Returns the number of cells associated with clue.

ipuz_clue_get_number

Returns the clue number.

ipuz_clue_ref

Refs the clue.

ipuz_clue_set_clue_text

Sets the clue text of clue to be clue_text.

ipuz_clue_set_coords

Sets the raw coordinates of clue, overwriting any current values.

ipuz_clue_set_direction

Sets the direction of clue to direction.

ipuz_clue_set_enumeration

Sets the enumeration of clue to be enumeration.

ipuz_clue_set_label

Sets the text to display in the list of clues instead of the clue number.

ipuz_clue_set_location

Sets the location of clue to be location. This is used for IpuzArrowword.

ipuz_clue_set_number

Sets the clue number of clue to number.

ipuz_clue_unref

Unrefs clue, which will be freed when the reference count reaches 0.