aboutsummaryrefslogblamecommitdiffstats
path: root/shell/e-shell.h
blob: fd0e26e11b6be7da6cfef2962a3294ad8b464cb8 (plain) (tree)
1
2
3
4
5
6
7
8


                                                                           
                                                        

                                                                
                                                                   
                                                        







                                                                    

                                                                   

   

                 
 
                           


















                                           
 
             
 



                                            

                                                          
 








                                  

                                   
                                                                                                    

                                          
  
 




                                         
 









                                                                    
                


                                                                          
                                                       


                                                                
 
           
 
                      
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* e-shell.h
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef E_SHELL_H
#define E_SHELL_H

#include "e-shell-common.h"

/* Standard GObject macros */
#define E_TYPE_SHELL \
    (e_shell_get_type ())
#define E_SHELL(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_SHELL, EShell))
#define E_SHELL_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_SHELL, EShellClass))
#define E_IS_SHELL(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_SHELL))
#define E_IS_SHELL_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_SHELL))
#define E_SHELL_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_SHELL, EShellClass))

G_BEGIN_DECLS

typedef struct _EShell EShell;
typedef struct _EShellClass EShellClass;
typedef struct _EShellPrivate EShellPrivate;

typedef enum _EShellLineStatus EShellLineStatus;
typedef enum _EShellStartupLineMode EShellStartupLineMode;

struct _EShell {
    GObject parent;
    EShellPrivate *priv;
};

struct _EShellClass {
    GObjectClass parent_class;
};

enum _EShellLineStatus {
    E_SHELL_LINE_STATUS_ONLINE,
    E_SHELL_LINE_STATUS_GOING_OFFLINE, /* NB: really means changing state in either direction */
    E_SHELL_LINE_STATUS_OFFLINE,
    E_SHELL_LINE_STATUS_FORCED_OFFLINE
};

enum _EShellStartupLineMode {
    E_SHELL_STARTUP_LINE_MODE_CONFIG,
    E_SHELL_STARTUP_LINE_MODE_ONLINE,
    E_SHELL_STARTUP_LINE_MODE_OFFLINE
};

GType       e_shell_get_type        (void);
EShell *    e_shell_new         (gboolean online);
GtkWidget * e_shell_create_window       (EShell *shell);
gboolean    e_shell_handle_uri      (EShell *shell,
                                                 const gchar *uri);
void        e_shell_send_receive        (EShell *shell,
                         GtkWindow *parent);
gboolean    e_shell_get_online      (EShell *shell);
void        e_shell_set_online      (EShell *shell,
                         gboolean online);
EShellLineStatus
        e_shell_get_line_status     (EShell *shell);
void        e_shell_set_line_status     (EShell *shell,
                                                 EShellLineStatus status);
GtkWidget * e_shell_get_preferences_window  (void);
gboolean    e_shell_is_busy         (EShell *shell);
gboolean    e_shell_do_quit         (EShell *shell);
gboolean    e_shell_quit            (EShell *shell);

G_END_DECLS

#endif /* E_SHELL_H */