Main Page Modules Alphabetical List Data Structures File List Data Fields Globals

# combocell.h File Reference

`#include <glib.h>`
`#include "basiccell.h"`
`#include "QuickFill.h"`

## Data Structures

struct | ComboCell

## Functions

BasicCell * | gnc_combo_cell_new (void)
void | gnc_combo_cell_init (ComboCell *cell)
void | gnc_combo_cell_set_value (ComboCell *cell, const char *value)
void | gnc_combo_cell_clear_menu (ComboCell *cell)
void | gnc_combo_cell_add_menu_item (ComboCell *cell, char *menustr)
void | gnc_combo_cell_set_strict (ComboCell *cell, gboolean strict)
void | gnc_combo_cell_set_complete_char (ComboCell *cell, char complete_char)
void | gnc_combo_cell_add_ignore_string (ComboCell *cell, const char *ignore_string)
void | gnc_combo_cell_set_autosize (ComboCell *cell, gboolean autosize)
void | gnc_combo_cell_set_autopop (gboolean auto_pop_combos)
void | gnc_combo_cell_use_quickfill_cache (ComboCell *cell, QuickFill *shared_qf)

## Detailed Description

@breif The ComboCell object implements a cell handler with a "combination-box" pull-down menu in it.

On output, the currently selected menu item is displayed. On input, the user can select from a list in the pull-down menu, or use the keyboard to slect a menu entry by typing the first few menu characters.

Author:
  Created Jan 1998 Linas Vepstas , Copyright (c) 1998 Linas Vepstas <linas@linas.org> , Copyright (c) 2000 Dave Peticolas

## Function Documentation

void gnc_combo_cell_add_ignore_string | ( | ComboCell * | cell,
|  | const char * | ignore_string
| ) |

| Add a string to a list of strings which, if the cell has that value, will cause the cell to be uneditable on 'enter'.

void gnc_combo_cell_add_menu_item | ( | ComboCell * | cell,
|  | char * | menustr
| ) |

| Add a menu item to the list.

void gnc_combo_cell_set_autopop | ( | gboolean | auto_pop_combos | ) |

| Determines whether combocells are automatically raised upon typing. Defaults to false. This is a 'class' method.

void gnc_combo_cell_set_autosize | ( | ComboCell * | cell,
|  | gboolean | autosize
| ) |

| Determines whether the popup list autosizes itself or uses all available space. FALSE by default.

void gnc_combo_cell_set_complete_char | ( | ComboCell * | cell,
|  | char | complete_char
| ) |

| Sets a character used for special completion processing.

void gnc_combo_cell_set_strict | ( | ComboCell * | cell,
|  | gboolean | strict
| ) |

| Determines whether the cell will accept strings not in the menu. Defaults to strict, i.e., only menu items are accepted.

void gnc_combo_cell_use_quickfill_cache | ( | ComboCell * | cell,
|  | QuickFill * | shared_qf
| ) |

Tell the combocell to use a shared QuickFill object. Using this routine can dramatically improve performance when creating combocells with a large number of entries. For example, users with thousands of accounts are complaining about 10-second register startup times, of which 98% of the cpu is spent building the multi-thousand entry quickfill. When a shared quickfill is specified, the combo-cell will not add to nor delete the quickfill; it is the users resonsibility to manage the quickfill object. The combocell will *not* make a copy of teh quickfill.