Changeset 49 for trunk/src/IDocument.cxx
- Timestamp:
- 04/13/06 05:47:01 (3 years ago)
- Files:
-
- 1 modified
-
trunk/src/IDocument.cxx (modified) (21 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/IDocument.cxx
r45 r49 36 36 37 37 /// 38 /// @brief Gets the Document's error quark.38 /// @brief Gets the IDocument's error quark. 39 39 /// 40 40 /// The first time it's called will create the new quark value for the … … 42 42 /// quark value. 43 43 /// 44 /// @return The Document's quark. 44 /// The error quark is used by Glib's g_set_error() function to set the 45 /// domain in that the error happened. EPDFVIEW_DOCUMENT_ERROR has been 46 /// defined to call this function, use that defined string when using 47 /// g_set_error() inside a document's class. 48 /// 49 /// @return The IDocument's quark. 45 50 /// 46 51 GQuark … … 114 119 115 120 /// 116 /// @brief Constructs a new Document object.121 /// @brief Constructs a new IDocument object. 117 122 /// 118 123 IDocument::IDocument () … … 139 144 140 145 /// 141 /// @brief Deletes all dynamically created objects of Document.146 /// @brief Deletes all dynamically created objects of IDocument. 142 147 /// 143 148 IDocument::~IDocument () … … 215 220 /// @brief Gets the document's subject. 216 221 /// 217 /// @return The subject of the document or an empty string i gthe document don't222 /// @return The subject of the document or an empty string if the document don't 218 223 /// have subject. 219 224 /// … … 243 248 /// @brief Gets the document's keywords. 244 249 /// 245 /// @return An string with all keywords separated by white space, or an empty250 /// @return An string with all keywords separated by white space, or an empty 246 251 /// string if the document have no keywords. 247 252 /// … … 259 264 /// @brief Sets the document's keywords. 260 265 /// 261 /// @param keywords A white space separated list of keywords.266 /// @param keywords A white space separated list of keywords. 262 267 /// 263 268 void … … 326 331 /// @brief Gets the document's format. 327 332 /// 328 /// @returns The PDFversion of the document or an empty string if the version333 /// @returns The version of the document or an empty string if the version 329 334 /// is not available (usually only when the document has not been 330 335 /// loaded yet). … … 341 346 342 347 /// 343 /// @brief Sets the document format.348 /// @brief Sets the document's format. 344 349 /// 345 350 /// @param format Set the format in which the document is. … … 353 358 354 359 /// 355 /// @brief Gets if the document is lineari zed.356 /// 357 /// @return The string "Yes" if the document is optimi zed for web viewing, "No"358 /// if it's not optimi zed or an empty string if this information is360 /// @brief Gets if the document is linearised. 361 /// 362 /// @return The string "Yes" if the document is optimised for web viewing, "No" 363 /// if it's not optimised or an empty string if this information is 359 364 /// not available. 360 365 /// … … 370 375 371 376 /// 372 /// @brief Sets if the document is lineari zed.377 /// @brief Sets if the document is linearised. 373 378 /// 374 379 /// @param linearized Set to TRUE if the document is linearized. 375 /// F alseotherwise.380 /// FALSE otherwise. 376 381 /// 377 382 void … … 513 518 /// 514 519 /// @return The file name that contains the document, or an empty string 515 /// if the document isn't lo eaded yet.520 /// if the document isn't loaded yet. 516 521 /// 517 522 const gchar * … … 533 538 IDocument::setFileName (const gchar *fileName) 534 539 { 535 g_assert (NULL != fileName && "Tried to set a NULL file name.");540 g_assert (NULL != fileName && "Tried to set a NULL file name."); 536 541 537 542 g_free (m_FileName); … … 605 610 /// Changes the current page to be the page @a pageNum. If @a pageNum is 606 611 /// greater than the document's last page, then the current page becomes 607 /// the last page. If @ pageNum is instead less then the first page (i.e.,612 /// the last page. If @a pageNum is instead less then the first page (i.e., 608 613 /// <= 0) then the current page becomes the first (i.e., 1). 609 614 /// … … 651 656 /// @brief Rotates 90 to the left. 652 657 /// 653 /// Substract 90 degre ss to the document's rotation.658 /// Substract 90 degrees to the document's rotation. 654 659 /// 655 660 void … … 666 671 /// @brief Rotates 90 to the right. 667 672 /// 668 /// Adds 90 degre ss to the document's rotation.673 /// Adds 90 degrees to the document's rotation. 669 674 /// 670 675 void … … 677 682 /// @brief Checks if is possible to zoom in. 678 683 /// 679 /// Checks if after zooming in tthe zoom level will be below the max level.684 /// Checks if after zooming in the zoom level will be below the max level. 680 685 /// 681 686 gboolean … … 688 693 /// @brief Checks if is possible to zoom out. 689 694 /// 690 /// Checks if after zoomin out the zoom level will be above the min level.695 /// Checks if after zooming out the zoom level will be above the min level. 691 696 /// 692 697 gboolean … … 710 715 /// @brief Zooms In. 711 716 /// 712 /// Adds a fixed ammount to the scale / zoom level. 717 /// Adds a fixed amount to the scale / zoom level if the zoom level has not 718 /// reached the max. 719 /// 720 /// @see canZoomIn() 713 721 /// 714 722 void … … 724 732 /// @brief Zooms Out. 725 733 /// 726 /// Substracts a fixed amount to the scale / zoom level. 734 /// Substracts a fixed amount to the scale / zoom level is the zoom level 735 /// has not reached the min. 736 /// 737 /// @see canZoomOut() 727 738 /// 728 739 void … … 761 772 /// @brief Zooms the document to fit the width. 762 773 /// 763 /// It tries to get the best zooms / sc lale level that will let the document764 /// fit into @a width, wi htout looking into any height.774 /// It tries to get the best zooms / scale level that will let the document 775 /// fit into @a width, without looking into any height. 765 776 /// 766 777 /// @param width The width to fit the document to.
