author | zecke <zecke> | 2004-02-02 16:05:42 (UTC) |
---|---|---|
committer | zecke <zecke> | 2004-02-02 16:05:42 (UTC) |
commit | 44e49951c71b277bd05ecc9857ec39d73a61b35e (patch) (unidiff) | |
tree | 1e55939962663d1b135bc4a23f5458d9751880bc /libopie/ofileselector.cpp | |
parent | 63746d6ac570b5935a75556a05fe92dacbc2d6ae (diff) | |
download | opie-44e49951c71b277bd05ecc9857ec39d73a61b35e.zip opie-44e49951c71b277bd05ecc9857ec39d73a61b35e.tar.gz opie-44e49951c71b277bd05ecc9857ec39d73a61b35e.tar.bz2 |
Add some API Docu
-rw-r--r-- | libopie/ofileselector.cpp | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/libopie/ofileselector.cpp b/libopie/ofileselector.cpp index 577e916..9afe9c7 100644 --- a/libopie/ofileselector.cpp +++ b/libopie/ofileselector.cpp | |||
@@ -628,6 +628,35 @@ void OFileViewFileSystem::activate( const QString& str) { | |||
628 | } | 628 | } |
629 | 629 | ||
630 | /* Selector */ | 630 | /* Selector */ |
631 | /** | ||
632 | * @short new and complete c'tor | ||
633 | * | ||
634 | * Create a OFileSelector to let the user select a file. It can | ||
635 | * either be used to open a file, select a save name in a dir or | ||
636 | * as a dropin for the FileSelector. | ||
637 | * | ||
638 | * <pre> | ||
639 | * QMap<QString, QStringList> mimeTypes; | ||
640 | * QStringList types; | ||
641 | * types << "text[slash]* "; | ||
642 | * types << "audio[slash]*"; | ||
643 | * mimeTypes.insert( tr("Audio and Text"), types ); | ||
644 | * mimeTypes.insert( tr("All"), "*[slash]*); | ||
645 | * | ||
646 | * now you could create your fileselector | ||
647 | * </pre> | ||
648 | * | ||
649 | * | ||
650 | * @param parent the parent of this widget | ||
651 | * @param mode The mode from the enum Mode (Open,Save,FILESELECTOR) | ||
652 | * @param sel The selector to be used | ||
653 | * @param dirName The name of the dir to start int | ||
654 | * @param fileName The fileName placed in the fileselector lineedit | ||
655 | * @param mimetypes The MimeType map of used mimetypes | ||
656 | * @param showNew Show a New Button. Most likely to be used in the FileSelector view. | ||
657 | * @param showClose Show a Close Button. Most likely to be used in FileSelector view. | ||
658 | * | ||
659 | */ | ||
631 | OFileSelector::OFileSelector( QWidget* parent, int mode, int sel, | 660 | OFileSelector::OFileSelector( QWidget* parent, int mode, int sel, |
632 | const QString& dirName, const QString& fileName, | 661 | const QString& dirName, const QString& fileName, |
633 | const MimeTypes& mimetypes, | 662 | const MimeTypes& mimetypes, |
@@ -667,6 +696,10 @@ OFileSelector::OFileSelector( QWidget* parent, int mode, int sel, | |||
667 | slotViewChange( str ); | 696 | slotViewChange( str ); |
668 | 697 | ||
669 | } | 698 | } |
699 | |||
700 | /** | ||
701 | * This a convience c'tor to just substitute the use of FileSelector | ||
702 | */ | ||
670 | OFileSelector::OFileSelector( const QString& mimeFilter, QWidget* parent, const char* name, | 703 | OFileSelector::OFileSelector( const QString& mimeFilter, QWidget* parent, const char* name, |
671 | bool showNew, bool showClose ) | 704 | bool showNew, bool showClose ) |
672 | : QWidget( parent, name ) | 705 | : QWidget( parent, name ) |
@@ -763,28 +796,65 @@ void OFileSelector::initViews() { | |||
763 | m_views.insert( QObject::tr("Files"), in ); | 796 | m_views.insert( QObject::tr("Files"), in ); |
764 | m_views.insert( QObject::tr("All Files"), in ); | 797 | m_views.insert( QObject::tr("All Files"), in ); |
765 | } | 798 | } |
799 | |||
800 | /** | ||
801 | * d'tor | ||
802 | */ | ||
766 | OFileSelector::~OFileSelector() { | 803 | OFileSelector::~OFileSelector() { |
767 | 804 | ||
768 | } | 805 | } |
806 | |||
807 | /** | ||
808 | * Convience function for the fileselector | ||
809 | * make sure to delete the DocLnk | ||
810 | * | ||
811 | * @see DocLnk | ||
812 | * @todo remove in ODP | ||
813 | */ | ||
769 | const DocLnk* OFileSelector::selected() { | 814 | const DocLnk* OFileSelector::selected() { |
770 | DocLnk* lnk = new DocLnk( currentView()->selectedDocument() ); | 815 | DocLnk* lnk = new DocLnk( currentView()->selectedDocument() ); |
771 | return lnk; | 816 | return lnk; |
772 | } | 817 | } |
818 | |||
819 | /** | ||
820 | * | ||
821 | * @return the name of the selected file | ||
822 | */ | ||
773 | QString OFileSelector::selectedName()const{ | 823 | QString OFileSelector::selectedName()const{ |
774 | return currentView()->selectedName(); | 824 | return currentView()->selectedName(); |
775 | } | 825 | } |
826 | |||
827 | /** | ||
828 | * @return the selected path | ||
829 | */ | ||
776 | QString OFileSelector::selectedPath()const { | 830 | QString OFileSelector::selectedPath()const { |
777 | return currentView()->selectedPath(); | 831 | return currentView()->selectedPath(); |
778 | } | 832 | } |
833 | |||
834 | /** | ||
835 | * @return the directory name | ||
836 | */ | ||
779 | QString OFileSelector::directory()const { | 837 | QString OFileSelector::directory()const { |
780 | return currentView()->directory(); | 838 | return currentView()->directory(); |
781 | } | 839 | } |
840 | |||
841 | /** | ||
842 | * @return a DocLnk for the selected document | ||
843 | */ | ||
782 | DocLnk OFileSelector::selectedDocument()const { | 844 | DocLnk OFileSelector::selectedDocument()const { |
783 | return currentView()->selectedDocument(); | 845 | return currentView()->selectedDocument(); |
784 | } | 846 | } |
847 | |||
848 | /** | ||
849 | * @return the number of items for the current view | ||
850 | */ | ||
785 | int OFileSelector::fileCount()const { | 851 | int OFileSelector::fileCount()const { |
786 | return currentView()->fileCount(); | 852 | return currentView()->fileCount(); |
787 | } | 853 | } |
854 | |||
855 | /** | ||
856 | * @return reparse the file content | ||
857 | */ | ||
788 | void OFileSelector::reread() { | 858 | void OFileSelector::reread() { |
789 | return currentView()->reread(); | 859 | return currentView()->reread(); |
790 | } | 860 | } |
@@ -800,9 +870,17 @@ bool OFileSelector::showClose()const { | |||
800 | MimeTypes OFileSelector::mimeTypes()const { | 870 | MimeTypes OFileSelector::mimeTypes()const { |
801 | return m_mimeType; | 871 | return m_mimeType; |
802 | } | 872 | } |
873 | |||
874 | /** | ||
875 | * @return the Mode of the OFileSelector | ||
876 | */ | ||
803 | int OFileSelector::mode()const{ | 877 | int OFileSelector::mode()const{ |
804 | return m_mode; | 878 | return m_mode; |
805 | } | 879 | } |
880 | |||
881 | /** | ||
882 | * @return the Selector of the OFileSelector | ||
883 | */ | ||
806 | int OFileSelector::selector()const{ | 884 | int OFileSelector::selector()const{ |
807 | return m_selector; | 885 | return m_selector; |
808 | } | 886 | } |