~ubuntu-branches/ubuntu/oneiric/evince/oneiric-updates

« back to all changes in this revision

Viewing changes to help/reference/libview/html/ch01.html

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2009-11-05 17:21:47 UTC
  • mto: (1.6.3 upstream)
  • mto: This revision was merged to the branch mainline in revision 96.
  • Revision ID: james.westby@ubuntu.com-20091105172147-ao0nlfb9368zmyhj
Tags: upstream-2.29.1
Import upstream version 2.29.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
22
22
</tr></table>
23
23
<div class="chapter" lang="en">
24
24
<div class="titlepage"><div><div><h2 class="title">
25
 
<a name="id2663358"></a>Evince View</h2></div></div></div>
 
25
<a name="id2895943"></a>Evince View</h2></div></div></div>
26
26
<div class="toc"><dl>
27
27
<dt>
28
28
<span class="refentrytitle"><a href="libevview-EvJobPrint.html">EvJobPrint</a></span><span class="refpurpose"></span>
575
575
                                                        gpointer   user_data)      : Run Last
576
576
evjobfind :the object which received the signal.
577
577
arg1 :
578
 
user_data :user data set when the signal handler was connected.ev-page-cache3LIBEVVIEW Libraryev-page-cacheSynopsisEvPageCache *       ev_page_cache_new                   (EvDocument *document);
579
 
gint                ev_page_cache_get_n_pages           (EvPageCache *page_cache);
580
 
const char *        ev_page_cache_get_title             (EvPageCache *page_cache);
581
 
void                ev_page_cache_get_size              (EvPageCache *page_cache,
582
 
                                                         gint page,
583
 
                                                         gint rotation,
584
 
                                                         gfloat scale,
585
 
                                                         gint *width,
586
 
                                                         gint *height);
587
 
void                ev_page_cache_get_max_width         (EvPageCache *page_cache,
588
 
                                                         gint rotation,
589
 
                                                         gfloat scale,
590
 
                                                         gint *width);
591
 
void                ev_page_cache_get_max_height        (EvPageCache *page_cache,
592
 
                                                         gint rotation,
593
 
                                                         gfloat scale,
594
 
                                                         gint *height);
595
 
void                ev_page_cache_get_height_to_page    (EvPageCache *page_cache,
596
 
                                                         gint page,
597
 
                                                         gint rotation,
598
 
                                                         gfloat scale,
599
 
                                                         gint *height,
600
 
                                                         gint *dual_height);
601
 
void                ev_page_cache_get_thumbnail_size    (EvPageCache *page_cache,
602
 
                                                         gint page,
603
 
                                                         gint rotation,
604
 
                                                         gint *width,
605
 
                                                         gint *height);
606
 
gint                ev_page_cache_get_max_label_chars   (EvPageCache *page_cache);
607
 
char *              ev_page_cache_get_page_label        (EvPageCache *page_cache,
608
 
                                                         gint page);
609
 
gboolean            ev_page_cache_has_nonnumeric_page_labels
610
 
                                                        (EvPageCache *page_cache);
611
 
const EvDocumentInfo * ev_page_cache_get_info           (EvPageCache *page_cache);
612
 
gboolean            ev_page_cache_get_dual_even_left    (EvPageCache *page_cache);
613
 
gint                ev_page_cache_get_current_page      (EvPageCache *page_cache);
614
 
void                ev_page_cache_set_current_page      (EvPageCache *page_cache,
615
 
                                                         int page);
616
 
void                ev_page_cache_set_current_page_history
617
 
                                                        (EvPageCache *page_cache,
618
 
                                                         int page);
619
 
gboolean            ev_page_cache_set_page_label        (EvPageCache *page_cache,
620
 
                                                         const char *page_label);
621
 
EvPageCache *       ev_page_cache_get                   (EvDocument *document);
622
 
gboolean            ev_page_cache_check_dimensions      (EvPageCache *page_cache);
623
 
Description
624
 
Detailsev_page_cache_new ()ev_page_cache_newEvPageCache *       ev_page_cache_new                   (EvDocument *document);
625
 
document :
626
 
Returns :
627
 
ev_page_cache_get_n_pages ()ev_page_cache_get_n_pagesgint                ev_page_cache_get_n_pages           (EvPageCache *page_cache);
628
 
page_cache :
629
 
Returns :
630
 
ev_page_cache_get_title ()ev_page_cache_get_titleconst char *        ev_page_cache_get_title             (EvPageCache *page_cache);
631
 
page_cache :
632
 
Returns :
633
 
ev_page_cache_get_size ()ev_page_cache_get_sizevoid                ev_page_cache_get_size              (EvPageCache *page_cache,
634
 
                                                         gint page,
635
 
                                                         gint rotation,
636
 
                                                         gfloat scale,
637
 
                                                         gint *width,
638
 
                                                         gint *height);
639
 
page_cache :
640
 
page :
641
 
rotation :
642
 
scale :
643
 
width :
644
 
height :
645
 
ev_page_cache_get_max_width ()ev_page_cache_get_max_widthvoid                ev_page_cache_get_max_width         (EvPageCache *page_cache,
646
 
                                                         gint rotation,
647
 
                                                         gfloat scale,
648
 
                                                         gint *width);
649
 
page_cache :
650
 
rotation :
651
 
scale :
652
 
width :
653
 
ev_page_cache_get_max_height ()ev_page_cache_get_max_heightvoid                ev_page_cache_get_max_height        (EvPageCache *page_cache,
654
 
                                                         gint rotation,
655
 
                                                         gfloat scale,
656
 
                                                         gint *height);
657
 
page_cache :
658
 
rotation :
659
 
scale :
660
 
height :
661
 
ev_page_cache_get_height_to_page ()ev_page_cache_get_height_to_pagevoid                ev_page_cache_get_height_to_page    (EvPageCache *page_cache,
662
 
                                                         gint page,
663
 
                                                         gint rotation,
664
 
                                                         gfloat scale,
665
 
                                                         gint *height,
666
 
                                                         gint *dual_height);
667
 
page_cache :
668
 
page :
669
 
rotation :
670
 
scale :
671
 
height :
672
 
dual_height :
673
 
ev_page_cache_get_thumbnail_size ()ev_page_cache_get_thumbnail_sizevoid                ev_page_cache_get_thumbnail_size    (EvPageCache *page_cache,
674
 
                                                         gint page,
675
 
                                                         gint rotation,
676
 
                                                         gint *width,
677
 
                                                         gint *height);
678
 
page_cache :
679
 
page :
680
 
rotation :
681
 
width :
682
 
height :
683
 
ev_page_cache_get_max_label_chars ()ev_page_cache_get_max_label_charsgint                ev_page_cache_get_max_label_chars   (EvPageCache *page_cache);
684
 
page_cache :
685
 
Returns :
686
 
ev_page_cache_get_page_label ()ev_page_cache_get_page_labelchar *              ev_page_cache_get_page_label        (EvPageCache *page_cache,
687
 
                                                         gint page);
688
 
page_cache :
689
 
page :
690
 
Returns :
691
 
ev_page_cache_has_nonnumeric_page_labels ()ev_page_cache_has_nonnumeric_page_labelsgboolean            ev_page_cache_has_nonnumeric_page_labels
692
 
                                                        (EvPageCache *page_cache);
693
 
page_cache :
694
 
Returns :
695
 
ev_page_cache_get_info ()ev_page_cache_get_infoconst EvDocumentInfo * ev_page_cache_get_info           (EvPageCache *page_cache);
696
 
page_cache :
697
 
Returns :
698
 
ev_page_cache_get_dual_even_left ()ev_page_cache_get_dual_even_leftgboolean            ev_page_cache_get_dual_even_left    (EvPageCache *page_cache);
699
 
page_cache :
700
 
Returns :
701
 
ev_page_cache_get_current_page ()ev_page_cache_get_current_pagegint                ev_page_cache_get_current_page      (EvPageCache *page_cache);
702
 
page_cache :
703
 
Returns :
704
 
ev_page_cache_set_current_page ()ev_page_cache_set_current_pagevoid                ev_page_cache_set_current_page      (EvPageCache *page_cache,
705
 
                                                         int page);
706
 
page_cache :
707
 
page :
708
 
ev_page_cache_set_current_page_history ()ev_page_cache_set_current_page_historyvoid                ev_page_cache_set_current_page_history
709
 
                                                        (EvPageCache *page_cache,
710
 
                                                         int page);
711
 
page_cache :
712
 
page :
713
 
ev_page_cache_set_page_label ()ev_page_cache_set_page_labelgboolean            ev_page_cache_set_page_label        (EvPageCache *page_cache,
714
 
                                                         const char *page_label);
715
 
page_cache :
716
 
page_label :
717
 
Returns :
718
 
ev_page_cache_get ()ev_page_cache_getEvPageCache *       ev_page_cache_get                   (EvDocument *document);
719
 
document :
720
 
Returns :
721
 
ev_page_cache_check_dimensions ()ev_page_cache_check_dimensionsgboolean            ev_page_cache_check_dimensions      (EvPageCache *page_cache);
722
 
page_cache :
723
 
Returns :
724
 
ev-view3LIBEVVIEW Libraryev-viewSynopsis                    EvView;
 
578
user_data :user data set when the signal handler was connected.ev-page-cache3LIBEVVIEW Libraryev-page-cacheSynopsisDescription
 
579
Detailsev-view3LIBEVVIEW Libraryev-viewSynopsis                    EvView;
725
580
                    EvViewClass;
726
581
enum                EvSizingMode;
727
582
enum                EvViewSelectionMode;
728
583
GtkWidget*          ev_view_new                         (void);
729
 
void                ev_view_set_document                (EvView *view,
730
 
                                                         EvDocument *document);
731
584
void                ev_view_set_loading                 (EvView *view,
732
585
                                                         gboolean loading);
733
586
void                ev_view_reload                      (EvView *view);
756
609
gboolean            ev_view_can_zoom_out                (EvView *view);
757
610
void                ev_view_zoom_out                    (EvView *view);
758
611
void                ev_view_set_zoom                    (EvView *view,
759
 
                                                         double factor,
760
 
                                                         gboolean relative);
761
 
void                ev_view_set_zoom_for_size           (EvView *view,
762
 
                                                         int width,
763
 
                                                         int height,
764
 
                                                         int vsb_width,
765
 
                                                         int hsb_height);
 
612
                                                         double factor);
766
613
double              ev_view_get_zoom                    (EvView *view);
767
 
void                ev_view_set_screen_dpi              (EvView *view,
768
 
                                                         gdouble dpi);
769
614
void                ev_view_rotate_left                 (EvView *view);
770
615
void                ev_view_rotate_right                (EvView *view);
771
616
void                ev_view_set_rotation                (EvView *view,
803
648
                                 +----EvView
804
649
Implemented Interfaces
805
650
EvView implements
806
 
 GtkBuildable and  AtkImplementorIface.Properties
 
651
 AtkImplementorIface and  GtkBuildable.Properties
807
652
  "continuous"               gboolean              : Read / Write
808
653
  "dual-page"                gboolean              : Read / Write
809
654
  "fullscreen"               gboolean              : Read / Write
817
662
  "external-link"                                  : Run Last / Action
818
663
  "handle-link"                                    : Run Last / Action
819
664
  "popup"                                          : Run Last / Action
820
 
  "zoom-invalid"                                   : Run Last / Action
821
665
Description
822
666
DetailsEvViewEvViewtypedef struct _EvView EvView;
823
667
EvViewClassEvViewClasstypedef struct _EvViewClass EvViewClass;
834
678
 
835
679
ev_view_new ()ev_view_newGtkWidget*          ev_view_new                         (void);
836
680
Returns :
837
 
ev_view_set_document ()ev_view_set_documentvoid                ev_view_set_document                (EvView *view,
838
 
                                                         EvDocument *document);
839
 
view :
840
 
document :
841
681
ev_view_set_loading ()ev_view_set_loadingvoid                ev_view_set_loading                 (EvView *view,
842
682
                                                         gboolean loading);
843
683
view :
901
741
ev_view_zoom_out ()ev_view_zoom_outvoid                ev_view_zoom_out                    (EvView *view);
902
742
view :
903
743
ev_view_set_zoom ()ev_view_set_zoomvoid                ev_view_set_zoom                    (EvView *view,
904
 
                                                         double factor,
905
 
                                                         gboolean relative);
 
744
                                                         double factor);
906
745
view :
907
746
factor :
908
 
relative :
909
 
ev_view_set_zoom_for_size ()ev_view_set_zoom_for_sizevoid                ev_view_set_zoom_for_size           (EvView *view,
910
 
                                                         int width,
911
 
                                                         int height,
912
 
                                                         int vsb_width,
913
 
                                                         int hsb_height);
914
 
view :
915
 
width :
916
 
height :
917
 
vsb_width :
918
 
hsb_height :
919
747
ev_view_get_zoom ()ev_view_get_zoomdouble              ev_view_get_zoom                    (EvView *view);
920
748
view :
921
749
Returns :
922
 
ev_view_set_screen_dpi ()ev_view_set_screen_dpivoid                ev_view_set_screen_dpi              (EvView *view,
923
 
                                                         gdouble dpi);
924
 
view :
925
 
dpi :
926
750
ev_view_rotate_left ()ev_view_rotate_leftvoid                ev_view_rotate_left                 (EvView *view);
927
751
view :
928
752
ev_view_rotate_right ()ev_view_rotate_rightvoid                ev_view_rotate_right                (EvView *view);
1003
827
                                                        gpointer user_data)      : Run Last / Action
1004
828
evview :the object which received the signal.
1005
829
arg1 :
1006
 
user_data :user data set when the signal handler was connected.The "zoom-invalid" signalEvView::zoom-invalidvoid                user_function                      (EvView  *evview,
1007
 
                                                        gpointer user_data)      : Run Last / Action
1008
 
evview :the object which received the signal.
1009
830
user_data :user data set when the signal handler was connected.ev-stock-icons3LIBEVVIEW Libraryev-stock-iconsSynopsis#define             EV_STOCK_ZOOM
1010
831
#define             EV_STOCK_ZOOM_PAGE
1011
832
#define             EV_STOCK_ZOOM_WIDTH