DhSidebar: Devhelp Reference Manual

## DhSidebar DhSidebar |

## Functions

GtkWidget * | dh_sidebar_new ()
DhLink * | dh_sidebar_get_selected_book ()
void | dh_sidebar_select_uri ()
void | dh_sidebar_set_search_string ()
void | dh_sidebar_set_search_focus ()

## Properties

DhBookManager * | book-manager | Read / Write / Construct Only

## Signals

void | link-selected | Run Last

## Types and Values

struct | DhSidebar
struct | DhSidebarClass

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBox
                        ╰── DhSidebar

## Implemented Interfaces

DhSidebar implements AtkImplementorIface, GtkBuildable and GtkOrientable.

## Description

## Functions

### dh_sidebar_new ()

    GtkWidget *
    dh_sidebar_new (DhBookManager *book_manager);

Create a new DhSidebar object.

#### Parameters

book_manager | the book manager |

#### Returns

a new DhSidebar object

### dh_sidebar_get_selected_book ()

    DhLink *
    dh_sidebar_get_selected_book (DhSidebar *sidebar);

Get the link pointing to the selected book.

#### Parameters

sidebar | a DhSidebar object |

#### Returns

the selected book link.

[nullable][transfer full]

### dh_sidebar_select_uri ()

    void
    dh_sidebar_select_uri (DhSidebar *sidebar,
                           const gchar *uri);

Select the given `uri` .

#### Parameters

sidebar | a DhSidebar object |
uri | the uri to select |

### dh_sidebar_set_search_string ()

    void
    dh_sidebar_set_search_string (DhSidebar *sidebar,
                                  const gchar *str);

Set the search string to `str` .

#### Parameters

sidebar | a DhSidebar object |
str | the string to seach |

### dh_sidebar_set_search_focus ()

    void
    dh_sidebar_set_search_focus (DhSidebar *sidebar);

Give the focus to the search entry.

#### Parameters

sidebar | a DhSidebar object |

## Types and Values

### struct DhSidebar

    struct DhSidebar;

### struct DhSidebarClass

    struct DhSidebarClass {
            GtkBoxClass parent_class;

            /* Signals */
            void (*link_selected) (DhSidebar *search,
                                   DhLink    *link);
    };

#### Members

`link_selected` () | Class handler for the “link-selected” signal |

## Property Details

### The `“book-manager”` property

      “book-manager”             DhBookManager *

The book maanger.

Flags: Read / Write / Construct Only

## Signal Details

### The `“link-selected”` signal

    void
    user_function (DhSidebar *sidebar,
                   gpointer   link,
                   gpointer   user_data)

#### Parameters

sidebar | a DhSidebar object |
link | the selected DhLink |
user_data | user data set when the signal handler was connected. |

Flags: Run Last