ultimatepp/bazaar/Controls4U/src.tpp/EditFileFolder_en-us.tpp
koldo 68755d19a6 Controls4U: Added dropping and some doc
git-svn-id: svn://ultimatepp.org/upp/trunk@13349 f0d560ea-af0d-0410-9eb7-867de7ffcac7
2019-06-02 19:30:24 +00:00

203 lines
No EOL
9.6 KiB
C++

topic "EditFileFolder";
[i448;a25;kKO9;2 $$1,0#37138531426314131252341829483380:class]
[l288;2 $$2,2#27521748481378242620020725143825:desc]
[0 $$3,0#96390100711032703541132217272105:end]
[H6;0 $$4,0#05600065144404261032431302351956:begin]
[i448;a25;kKO9;2 $$5,0#37138531426314131252341829483370:item]
[l288;a4;*@5;1 $$6,6#70004532496200323422659154056402:requirement]
[l288;i1121;b17;O9;~~~.1408;2 $$7,0#10431211400427159095818037425705:param]
[i448;b42;O9;2 $$8,8#61672508125594000341940100500538:tparam]
[b42;2 $$9,9#13035079074754324216151401829390:normal]
[2 $$0,0#00000000000000000000000000000000:Default]
[{_}%EN-US
[ {{10000@3 [s0; [*@7;4 EditFileFolder]]}}&]
[s3; &]
[s1;:EditFileFolder`:`:class:%- [@(0.0.255)3 class][3 _][*3 EditFileFolder][3 _:_][@(0.0.255)3 p
ublic][3 _][*@3;3 EditString]&]
[s0; &]
[s0; As seen in layout designer:&]
[s0; &]
[s2;
@@image:1525&137
(A/QAFgAAAAAAAAAAAHic7dpbCsMgEEDRbrCL6E76031lKd2JFYRAZ5Q4qY7R3kM+hSBcxTy2DVjWE1hLCGFv+wasIiYt2n5Xi4MD4MgUZ7btmrukwZ2nAnwxxVlqu+ZwTttwZoqTtjERHef98TrddhpD27gCEWcMO12n287mTdvwl923dd6mtnXetA1/2QOzztvatsibtuGv9DAo8mbfxnR67Nt6pdA2/DU/b+uwaRtDtH1PUkLb8Nf2/TZt4zp+/y5Z+QMhbcOZKU7dtsnoueK/mOIUbR/u9sBE9rZHL0qgvbGLC+hq9PICevkA0e75rw==)
&]
[s0; &]
[s0; As seen in program:&]
[s0; &]
[s0;l288;
@@image:1525&131
(A/QAFQAAAAAAAAAAAHic7ZtrUuM4EMe54B5iT7Kf9hh7gx2GdwhkIBAgCWDHDgkMAzVbu7M1xYc88StxC7J/W7PGY1uKY8KjwF1dKbndarXkn1Sykti2PRKIYRjky+3t7XA4hMVxnF6vZ9v2eDyGHZfwwa1+vw873OCDW5Zlwcf1BeXBYIBPxtj9/T0KnU6n2+2apokyHGxfcBcWxEF1xAziIyBuoQwf2OHPc5tMJjDCYuf55/kL8kfA3/4o5prrG1Ngj0mBwiSXXN6QAGm++Adsf++xky9utT3abzplzdlpOCXF3jq1CseebtTttaq9WrVWjszr7+OXTT6X9yMZsATS2JDwArcgwuW/rP0307+yxjVTrtjJJat/ZkdtdtiigxbtnbFdne1oVDwxXqyrubwzyYAlZxvbkoBtTI32P0z/i6lX7PQLO/YjVM9pr8nKOtvVUJ19arCSStunOdu5PJNkwBJI430T76oB23u6o31lyrVf/YIWFhZq54SpUVLZtsK2QlqahW3EmX+HX5m8hj5OzYE7PHWqc48fwbJ2Qb/8+rscSyCNF0nDMAK2sZNRr7G38eZFzWcbUjkj1CoqBN30P6FxthdCIumsxO3Z5CmaTuy1vKeRYXl8eqIcIg4RN/nlI9OYy+OOYAmwuUqw5O+S4XOSkuJgzeebmfoFC7Li1Qu+bvoa2ZPIM5/7Q3ykPAPbaZqY+1C8TrYfHzmCZRhvEZZAejQaDYfDgO3iiX38mUHrvoYnHapv+MpDbYXYnmldEo1kfHaHLYkPKHxXVHGStHTIL9PHERlFYyJpN97ZlM3FLxPHNjJ0klRTjlIklCiNlMETRyCQCJbVc1ZpPeCdiCWQHo/H4TPAwrGFSeFNjXPvJTRorqj6YKs/8IaGz0kSn+PUcU4cokSL3EHy4NJb5JItzlTqRNWzdUQUJ15Iw3aa8Rc908SmZ+pI5DKCZcU7GKGyHsU7jCVftxljAdvrdeuoTdDDNiECz3/3jIqap4WGj7dK64pbOJ7O9hN1dirbYZkaPLJ6RBqdKY6872kSSz8mccBEceKFlGzHR0mSvCjmXNiOYAndD63biVgCaSzak9D59krVPmizw/8VTVTarNxiW03a1Gm9QWuqp6uKu1YzRZkkynOyLWpa7pO+RYklUdInlq25cPLhggjINGxHIsuTl6cRrzUr2xEsUX7YbwuwBNKmaRJRwPbSkV1peXW5Aux9n+3NM1rTaaXh6bJKy4q7EmI7saeJXUhvnAvbKUcysQtPyvZUVmdtbiao0rOdMpmUaWR73JMYlg9gi7HkvyfBtiRge/HALjfZ/hlB9zxl3jc+LUKQjSatabTcoCWVPp66K9Wf2J78vFDIRyniFqkusiQuQaKCKI2IT2K7oh5J4ki6I+lROI1ISimbEzU9EQ9+/FZitlOTl/cr3JZ8fNLEj2MJsOVYcrYtywrY/lCxdzSGXXq5Sbs6ed9j6lRqUqFJG7ofBBEUWjx1l49m/l4yPqS5ZBbJYL6ScZ5jGhmw5Gzz37hyy5/71rZKOxrtau5Ogz5BNdrWvQjrGq023CXFxexYPHGXDm9fsLPvVhLXwLjPs+UjkTmmkQFLfgYYPt+++jYq1Iab9dti3eCKcqFmrNYsKDYzy1UDUwMRLr/Z88o8l1zkkgFLfgYYXrdzyeVtCD8D5PvtXHN9Y2qapuM44Byf2JwYhtHv929ublCGEZ+9Xg8+sMPY6XSwh+FHK4PBAJdwQEVY7u7u4A83zBTcJSL+Jzv4wwFlwxdYcLfb7fLfjUMwuRCK//cNBTSHTwTk/6SDG88QFl537Ass8Oe18vzz/EX5/wd3UXC1)
&]
[s0; &]
[s9; EditFileFolder is a field to introduce a folder path. It is
used indirectly through subclasses [^topic`:`/`/Controls4U`/src`/EditFile`$en`-us^ E
ditFile] and [^topic`:`/`/Controls4U`/src`/EditFolder`$en`-us^ EditFolder].&]
[s3; &]
[s3; &]
[ {{10000F(128)G(128)@1 [s0; [* Constructor Detail]]}}&]
[s3;%- &]
[s5;:EditFileFolder`:`:EditFileFolder`(`):%- [* EditFileFolder]()&]
[s2; Initializes EditFileFolder.&]
[s3; &]
[s0;%- &]
[ {{10000F(128)G(128)@1 [s0; [* Public Member List]]}}&]
[s4;%- &]
[s0;:Init`(`):%- [@(0.0.255) void]_[* Init]()&]
[s2; Inits EditFileFolder data. Called by the constructor.&]
[s3;%- &]
[s3;%- &]
[s4;%- &]
[s5;:ClearTypes`(`):%- [@(0.0.255) void]_[* ClearTypes]()&]
[s2; Removes all file types from FileSel.&]
[s3;%- &]
[s4;%- &]
[s0;:Type`(const char`*`,const char`*`):%- void_[* Type](const_char_`*[*@3 name],
const_char_`*[*@3 ext])&]
[s2; Adds a file type displayed as [%-*@3 name]. [%-*@3 ext] contains
a set of file masks separated by spaces. Example: Type(`"Source
files`", `"`*.c `*.h`").&]
[s3; &]
[s4;%- &]
[s5;:ActiveType`(int`):%- [@(0.0.255) void]_[* ActiveType]([@(0.0.255) int]_[*@3 type])&]
[s2; Sets the active file [%-*@3 type] .&]
[s3; &]
[s4;%- &]
[s5;:AllFilesType`(`):%- [@(0.0.255) void]_[* AllFilesType]()&]
[s2; Same as Type(`"All files`", `"`*.`*`").&]
[s3;%- &]
[s4;%- &]
[s5;:ActiveDir`(const Upp`:`:String`&`):%- [@(0.0.255) void]_[* ActiveDir]([@(0.0.255) cons
t]_[_^String^ String][@(0.0.255) `&]_[*@3 d])&]
[s2; Sets the active directory of file selector (directory where
file selector starts).&]
[s3; &]
[s4;%- &]
[s5;:MkDirOption`(bool`):%- [@(0.0.255) void]_[* MkDirOption]([@(0.0.255) bool]_[*@3 b])&]
[s2; Makes `"Make directory`" button visible. Default is true.&]
[s3; &]
[s4;%- &]
[s5;:BaseDir`(const char`*`):%- [@(0.0.255) void]_[* BaseDir]([@(0.0.255) const]_[@(0.0.255) c
har]_`*[*@3 dir])&]
[s2; Sets [%-*@3 dir] to be the base directory. If used, files can
be selected only inside this base directory (or its subdirectories)
and selected file paths are relative to it.&]
[s3; &]
[s4;%- &]
[s5;:Get`(`)const:%- [_^String^ String]_[* Get]()_[@(0.0.255) const]&]
[s2; Gets path in field.&]
[s3;%- &]
[s4;%- &]
[s5;:operator const char`*`(`)const:%- [@(0.0.255) operator]_[@(0.0.255) const]_[@(0.0.255) c
har]_`*()_[@(0.0.255) const]&]
[s2; Same as Get().&]
[s3;%- &]
[s4;%- &]
[s5;:operator`~`(`)const:%- [_^String^ String]_[* operator`~]()_[@(0.0.255) const]&]
[s2; Same as Get().&]
[s3;%- &]
[s4;%- &]
[s5;:EditFileFolder`:`:operator String`(`)const:%- [* operator_String]()_[@(0.0.255) cons
t]&]
[s2; Same as Get()&]
[s3;%- &]
[s4;%- &]
[s5;:Set`(const Upp`:`:String`&`):%- [@(0.0.255) void]_[* Set]([@(0.0.255) const]_[_^String^ S
tring][@(0.0.255) `&]_[*@3 s])&]
[s2; Sets path in field with [%-*@3 s].&]
[s3; &]
[s4;%- &]
[s5;:operator`=`(const char`*`):%- [_^EditFileFolder^ EditFileFolder]_`&[* operator`=]([@(0.0.255) c
onst]_[@(0.0.255) char]_`*[*@3 s])&]
[s2; Same as Set().&]
[s3; &]
[s4;%- &]
[s5;:EditFileFolder`:`:operator`<`<`=`(const String`&`):%- [@(0.0.255) void]_[* operator<
<`=]([@(0.0.255) const]_[_^String^ String][@(0.0.255) `&]_[*@3 s])&]
[s2; Same as Set().&]
[s3; &]
[s4;%- &]
[s5;:operator`=`(const Upp`:`:String`&`):%- [@(0.0.255) void]_[* operator`=]([@(0.0.255) co
nst]_[_^String^ String][@(0.0.255) `&]_[*@3 s])&]
[s2; Same as Set().&]
[s3; &]
[s4;%- &]
[s5;:IsEmpty`(`):%- [@(0.0.255) bool]_[* IsEmpty]()&]
[s2; Returns true if field is empty.&]
[s3;%- &]
[s4;%- &]
[s5;:NotNull`(bool`):%- [_^EditFileFolder^ EditFileFolder]_`&[* NotNull]([@(0.0.255) bool]_
[*@3 b])&]
[s2; If [%-*@3 b] is set to true null paths are not admitted.&]
[s3; &]
[s4;%- &]
[s5;:SelLoad`(bool`):%- [_^EditFileFolder^ EditFileFolder]_`&[* SelLoad]([@(0.0.255) bool]_
[*@3 load])&]
[s2; If [%-*@3 load ]is true, path is searched for loading. If it is
false, path is searched for saving.&]
[s3; &]
[s4;%- &]
[s5;:SetTitle`(const char`*`):%- [_^EditFileFolder^ EditFileFolder]_`&[* SetTitle]([@(0.0.255) c
onst]_[@(0.0.255) char]_`*[*@3 title])&]
[s2; [%-*@3 title ]is the String that will appear as title of the FileSel
window.&]
[s3; &]
[s4;%- &]
[s5;:UseOpenFolder`(bool`):%- [_^EditFileFolder^ EditFileFolder]_`&[* UseOpenFolder]([@(0.0.255) b
ool]_[*@3 use]_`=_[@(0.0.255) true])&]
[s2; If [%-*@3 use] is true, it shows a button to open the folder in
the path in a file browser.&]
[s3; &]
[s4;%- &]
[s5;:UseBrowse`(bool`):%- [_^EditFileFolder^ EditFileFolder]_`&[* UseBrowse]([@(0.0.255) bo
ol]_[*@3 use]_`=_[@(0.0.255) true])&]
[s2; If [%-*@3 use] is true, it shows a left button to search the path.&]
[s3; &]
[s4;%- &]
[s5;:UseBrowseRight`(bool`):%- [_^EditFileFolder^ EditFileFolder]_`&[* UseBrowseRight]([@(0.0.255) b
ool]_[*@3 use]_`=_[@(0.0.255) true])&]
[s2; If [%-*@3 use] is true, it shows a right button to search the
path.&]
[s3; &]
[s4;%- &]
[s5;:BrowseRightWidth`(int`):%- [_^EditFileFolder^ EditFileFolder]_`&[* BrowseRightWidth](
[@(0.0.255) int]_[*@3 w])&]
[s2; Sets the width [%-*@3 w] of the right browse button.&]
[s3; &]
[s4;%- &]
[s5;:BrowseOpenFolderWidth`(int`):%- [_^EditFileFolder^ EditFileFolder]_`&[* BrowseOpenFo
lderWidth]([@(0.0.255) int]_[*@3 w])&]
[s2; Sets the width [%-*@3 w] of the open folder button.&]
[s3; &]
[s4;%- &]
[s5;:UseDropping`(bool`):%- [_^EditFileFolder^ EditFileFolder]_`&[* UseDropping]([@(0.0.255) b
ool]_[*@3 use]_`=_[@(0.0.255) true])&]
[s2; If [%-*@3 use] is true, it shows a drop button to show the use
history.&]
[s3; &]
[s4;%- &]
[s5;:BrowseDroppingWidth`(int`):%- [_^EditFileFolder^ EditFileFolder]_`&[* BrowseDropping
Width]([@(0.0.255) int]_[*@3 w])&]
[s2; Set the width of the drop down list to [%-*@3 w] .&]
[s3; &]
[s4;%- &]
[s5;:WhenChange:%- [_^Callback^ Callback]_[* WhenChange]&]
[s2; Function to be called when path has been selected with FileSel
window, right button is pressed or ENTER key is entered with
cursor into field.&]
[s3;%- &]
[s4;%- &]
[s5;:Serialize`(Upp`:`:Stream`&`):%- [@(0.0.255) virtual] [@(0.0.255) void]_[* Serialize]([_^Upp`:`:Stream^ S
tream][@(0.0.255) `&]_[*@3 s])&]
[s2; EditFileFolder serialization with [%-*@3 s].&]
[s3; &]
[s4;%- &]
[s5;:Jsonize`(Upp`:`:JsonIO`&`):%- [@(0.0.255) virtual] [@(0.0.255) void]_[* Jsonize]([_^Upp`:`:JsonIO^ J
sonIO][@(0.0.255) `&]_[*@3 jio])&]
[s2; EditFileFolder serialization through JSON with [%-*@3 jio].&]
[s3; &]
[s4;%- &]
[s5;:Xmlize`(Upp`:`:XmlIO`&`):%- [@(0.0.255) void]_[* Xmlize]([_^Upp`:`:XmlIO^ XmlIO]_`&[*@3 x
ml])&]
[s2; EditFileFolder serialization through XML with [%-*@3 xml].&]
[s3; &]
[s0; ]]