Method

IpuzCluesadd_clue_set

Declaration [src]

IpuzClueDirection
ipuz_clues_add_clue_set (
  IpuzClues* clues,
  IpuzClueDirection direction,
  const gchar* label
)

Description [src]

Adds a new clue set to clues. This clue set will be in the direction of direction, and will be empty. If label is set, then it will set the label of the newly created clue set.

The return value of this function is the direction of the newly added clue set, and should be used to access the clue set going forward. Most of the time, the returned direction will be identical to direction. However, should you add multiple cluesets of the same direction but different labels, then the returned direction will be a new value starting at IpuzClueDirection.

If a clue set already exists with an identical direction or label, then a new clue set won’t be created and IpuzClueDirection will be returned.

Parameters

direction

Type: IpuzClueDirection

The direction of the newly added clue set.

label

Type: const gchar*

An optional label for the newly added clue set.

The argument can be NULL.
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.

Return value

Type: IpuzClueDirection

The direction of the newly created clue set, or IpuzClueDirection